Filters (Profiling)

Filtering is also known as "profiling" or "conditional content" and you can use it to include or exclude content depending on certain conditions. For example, you can set a topic to be included in your publication if the intended audience is beginners, but excluded if the audience is experts.

You can use filtering to include or exclude:

• Entire topics in a publication

• Elements in a topic, such as paragraphs, procedures, or steps in a list.

Filtering gives you more control over your content and can also give you more opportunities for your topics. Let's say that you have a topic that could be reused, if only it did not contain a particular paragraph. By filtering that paragraph, you can make the topic suitable for reuse, as you can include or exclude the paragraph when needed.

Paligo has several different types of filtering, but to begin with, we recommend you learn about "regular" filtering.

The workflow for "regular" filtering is:

1. You mark up the content that you want to filter. This tells Paligo what content can be filtered, and what conditions apply.

To set the conditions, you choose a type of filtering to apply and you set a filter value.

Paligo does not have one generic filter for everything. Instead, it has a range of filter types, called filter attributes. There are different filter attributes for filtering by product name, by audience, by country, and by market, among others.

For example, to filter a paragraph so that it only appears in a user guide for a Windows version of a product, you could set a filter attribute of os (operating system) and a filter value of Windows.

2. You set the filters you want Paligo to apply to the published output.

3. Paligo then:

• Includes all of the content that does not use the filters attributes you chose for publishing.

• Searches through your content to find any elements that have the filter attribute(s) that you set for the publication. For example, if you set an os filter attribute in the publication, Paligo will find all of the elements that are marked up to have an os filter attribute. These are the "matching" elements.

• Searches through the "matching" elements to check the filter values. Those with the same value that you set for the publication are included in the published output. Those that have different values are excluded.

Tip

If you want to exclude content, create filter values for the conditions where it should be included and also for where it should be excluded. For examples, see Mark Up Elements for Filtering and Mark Up Topics for Filtering.

Note

The process for setting up filtering is different for scoped filtering, taxonomy filtering, and filtering by language.

There are several ways of applying filters to your content in Paligo. They all involve marking up your content for filtering and then setting filters on the publication. But the process for doing this is different depending on which method of filtering you choose to use.

The two main types of filtering are:

• "Regular" filtering, where you edit a topic and apply a filter attribute and filter value to one or more elements. You can use "regular" filtering for filtering entire topics or individual elements in a topic.

To get started with "regular" filtering, see:

Filter Topics in a Publication

Filter Block Elements in a Topic

• Taxonomy filtering, where you set up taxonomy tags to represent the filter attributes and values, and you drag and drop them on to your topics. You can also set Paligo to use the taxonomy hierarchy for more complex filters, where Paligo uses the taxonomy hierarchy to determine which topics to include or exclude.

See taxonomy filtering for more details.

There is also scoped filtering. This is for when you want to use the same content in the same publication, but apply different filters depending on where the content appears.

You can use a mix of the different filtering types, if needed.

When you mark up your content for filtering, you can use the preview feature to see the effects of the filters. This is a good way of making sure that the filters work as expected, and is especially useful if you have used a combination of filters.

To preview the filters:

1. Find the topic that contains the filters in the Content Manager, and open it in the editor.

2. Select Preview > Profile settings.

3. Select Profiling.

4. For each filter attribute, select the field and choose the filter you want to apply for the preview. If you do not want to apply a particular filter, leave its field blank.

5. Select Apply.

The filter is applied to the preview of the topic:

• Any content that is not marked up to use the types of filter you have applied is included in the content.

• Any content that is marked up to use the filters you have applied, with the same values you have set, is included in the content.

• Any content that is marked up to use the filters you have applied, but with different values, is excluded.

For example, if you set the preview to show the Market filter attribute with a value of Europe, the topic would show:

• Any content that is not marked up to use the Market filter attribute

• Any content that is marked up to use the Market filter attribute and a value of Europe

The preview would exclude any content that has the Market filter attribute and any other value, such as Asia, North America, Australasia, etc.

6. Repeat steps 4 and 5 to change the filters for the preview and see how they affect the content.

To stop applying the filter preview, display the Profile settings dialog select the Profiling tab, and then select Reset.