Filtering and Formatting Content

You can use filters and macros to have the application make changes to text at run time. Use the admin console to turn these changes on or off, or to change the settings that govern how they work.

Each component type has a different role. Here's how they work in general:

Configuring Filters and Macros

The Filters and Macros admin console page for the root space lists the filters and macros installed for the community. By default, each space inherits the set of filters and macros from the global configuration defined in the root space. However, the list isn't shown for subspaces until you choose to copy them. When you click the Copy Global Filters button on the Filters and Macros page for a subspace, the application copies the list and configuration to the page. If you want to edit the list for a subspace, you'll need to click the button first.

Pre-Processing Filters

Pre processing filters are the very first filters to operate on your content. They are performed on the initial version of the content before all other macros and filters have done their work to generate content. For example, the HTML filter should be executed before any other macros or filters because otherwise it would strip out the HTML content that the other macros and filters introduce.

By default, there are no editable pre-processing filters.

Macros

A macro operates on, or adds, a specific part of content. For example, a macro could format a link or embed a window to display video. In early releases, many macros were typed directly into wiki markup using syntax that included curly braces to delimit the macro in the text. For example, the markup {color:red} could be used to set the color of text.

In the list, you'll see all of the macros installed on the system. Many of these, including macros whose functionality is tightly integrated into the content editor toolbar, are not available to be disabled. Those you can disable or delete are generally macros installed as separate components, such as in plugins.

Filters

Filters -- you can think of them as mid-processing filters -- operate on text after macros have executed, but before post-processing filters have done their work. By default, the application doesn't include any editable filters.

Post Processing Filters

Post-processing filters are your last chance to shape content before it's seen by other people. This is where you catch whatever is in the text, including whatever might have been added by other filters or macros.

One of the most important filters you can enable is the profanity filter. This filter automatically detects words in your profanity list and replaces them with ***. The profanity filter is the most commonly used filter; please consider using it. You use the filter by adding the words you want filtered out, then turning on the filter.

On the Filters and Macros page, scroll to the profanity filter and click its Settings link. On the filter settings page, enter the list of words you want filtered out of your content. Enter words and phrases separated by commas. If you've got more than a few entries, be sure to enter longer or broader phrases before smaller and more specific ones. For example, imagine that your list included both "gleeking boil-brained nit" and just "nit". Your entries will be evaluated in the order you enter them. So if you've got "nit" before "gleeking boil-brained nit", then content that includes "That's rubbish, you gleeking boil-brained nit" will be filtered to "That's rubbish, you gleeking boil-brained ***" -- in other words, you won't have filtered out the whole phrase.

Be sure to select check boxes for the parts of the content you want filtered, then click Save Properties. Back on the Filters and Macros page, click the profanity filter's On button to turn it on.