Filter Topics in a Publication

You can filter topics so that they are included/excluded in your published output. For example, if you have a topic that is only relevant to Mac users, you could set an os (operating system) filter on the topic, with a filter value of macos. Then, when you publish, you can set Paligo to include the topic if you are publishing a Mac user guide or exclude it if you are publishing a Windows user guide.

In this section, we explain how to filter topics using the "regular" way of filtering. But you can also filter topics by using taxonomy filtering, where you apply the filter attributes and values by dragging and dropping taxonomy tags.

To find out about using the "regular" way of filtering topics, watch the video or read the following instructions:

To use the "regular" way:

  1. Mark up the topics that you want to filter. Apply the filter attributes and values to the top section element in your topic.

  2. Apply the filters you want to use for publishing your output.

For more details on marking up and applying the filters, see the following sections.

If you want to filter entire topics, you need to mark them up so that Paligo knows which topics can be filtered and what filter conditions apply. Marking up involves giving the top section element (1) of a topic a filter attribute (2) and a filter value (3).

element-attribute-value.jpg

Note

Marking up the content tells Paligo what content can be filtered. It does not apply the filter. You apply the filter in the publishing settings when you publish the content.

To mark up a topic for filtering:

  1. Edit the topic that you want to filter, and then select the top section element in the Element Structure Menu. Select Go to element.

    select-section.jpg
  2. In the Element attributes section, select Add attribute and search for the filter attribute you want to use. Note that the Add attribute list includes all attributes, not just filters

    There are many different types of profile attribute (filter) that you can use, including product name, country, and audience. To find out about the different profile attributes, see Filter Attributes.

    section-element-attributes.jpg
  3. Use the Profiling values dialog to set the filter value. Think of setting the value as a way of telling Paligo where the content is applicable.

    For example, if you have a topic that is only applicable to a product named "ACME 1050", you could give it the xinfo:product filter attribute and set the filter value to ACME 1050.

    Choose from any of the available values or use Add value to create more values if needed.

    profiling-values.png

    You can have single values or you can add multiple values, where Paligo will include the topic if either of the values are a match.

    Note

    We have included some more detailed examples of how you can use filter conditions to include and exclude content at the end of this section.

  4. Repeat this process to markup any other topics you want to filter.

Example 1. Use multiple filter values to create an OR filter

Let's say you have a topic that is only applicable for customers in North America and the EU. You want to include the topic when you are publishing to those markets, but want to exclude it when you are publishing to the Middle East, Australia, and other markets. This is where you need an OR filter, as you want the content to appear when the market is North America or the EU.

To mark up the topic, you:

  1. Select the top section element in the topic.

  2. Add the xinfo:market attribute

  3. Set the attribute value. As the content applies to two markets, you have to set two values: North America and EU. Another option would be to create another filter that represents North America and the EU combined, but this could be cumbersome in this case.

filter-section-euamerica.jpg

When you publish the content, you can choose the filters for the publication.

FILTER-MARKET-PUBLISH.jpg
  • If you set the publication's market filter to North America, EU, or both North America and EU, the filtered topic is included.

  • If you set the publication's market filter to another region, such as Australia, the filtered topic is excluded.

  • If you do not set a market filter for the publication, the filtered topic is included. It is only excluded from the publication if the market filter is applied and the value for the market filter does not match North America or EU.


Example 2. Exclude a filter value rather than include it

Paligo's filtering is inclusive, which means that when you set a filter, you are telling Paligo what content you want to be included in the output. But there may be times where you want to exclude certain content rather than include it. For these situations, set up filter values for:

  • The conditions where you want the topic to be included

  • The conditions where you want the topic to be excluded.

Then, when you publish, you can tell Paligo which content to include. By including one condition, you automatically exclude the other possible conditions.

Let's say you have three types of users: administrators, engineers, and operators. You have a topic that you want to be included for the engineers and operators, but excluded for the administrators. To set this up you:

  1. Select the top section element in the topic.

  2. Add the audience attribute.

  3. Select the value for the audience attribute and create these values: "administrators", "engineers", "operators".

    Note that it is important to create values for where you want the topic to be included and also for where you want it to be excluded.

    profiling-values-audience-add.jpg
  4. Set the audience attribute value to "engineers" and "operators".

    filter-section-engineer.jpg

When you publish the content, you can choose the filters for the publication.

To publish for the administrator audience, you set the audience to "administrators".

publish-administrators-audience.jpg

The published output will then include:

  • Any topics that have an audience filter with a value of "administrators". The topic that you marked up has an audience filter with a value of "engineers" and "operators", and so it is not included in the published output.

  • All topics that do not have an audience filter

To publish for the engineers or operators, you set the publication's audience filter to "Engineers" and "Operators".

publish-engineers-audience.jpg

The published output will then include:

  • Any topics that have an audience filter with a value of "Engineers" or "Operators". So the topic that you marked up is included in the published output.

  • All topics that do not have an audience filter.


When you publish your content, you can choose which filters to apply to the published output (HTML5 help center, PDF, etc.).

  1. In the Content Manager, find the topic or publication that you want to publish. Select its options menu ( ... ) and select Publish.

  2. On the Publish document dialog, select an output type (PDF, HTML5, etc.), and set the Languages, Variables, and Optional Parameters.

    These are common publishing settings. To find out more, see Publishing Process.

  3. Select the Edit option in the Profiling attributes section. Paligo displays the Profiling attributes dialog.

    profiling-attributes-blank.png

    The Profiling attributes dialog contains a list of the filter attributes that you can use. There is a field for each attribute.

  4. Select the field for a filter attribute that you want to apply to your publication. A drop-down list of the available values appears. These are the values that have been created for the filter when the content was marked up for filtering.

    Choose the value that you want to apply.

    profiling-attributes.png

    You would normally just choose one value for each filter attribute, the variant that you want to publish at the moment. This is usually the recommended strategy. It's possible to choose multiple values for a filter, however. The filter then works as an OR filter, where Paligo will filter topics that contain any of the values you set (value 1 or value 2 or value 3, etc.).

    Tip

    When you choose filters, you are telling Paligo which content to include in the published output. But sometimes, you may want to exclude content rather than include it. For example, you might want to publish content for all audience types except administrators. To do this, you need to mark up the content so that:

    • The content you want to include has a condition (filter attribute) and a value

    • The content you want to exclude has the same condition as those that you want to include. But set a different value for the topics you want to exclude.

    When you publish, you choose which condition value to include. Paligo will then:

    • Include any content that has the matching condition and value

    • Include any content that does not use the matching condition

    • Exclude any content that uses the matching condition, but has a different value.

  5. Repeat step 4 for each attribute and value that you want to apply and then select OK.

    Note

    Only set a value for those filter attributes that you want to apply to your publication. For any attributes that you do not want to use, leave their fields blank. When there is no attribute set, Paligo ignores that type of filter.

  6. Select Publish document to publish your content.