Articles in this section

See more

Filter Publications

Avatar
Anders
  • Updated
Follow

You can filter topics to include or exclude them in your published output.

For example, if you have a topic 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 publish a Mac user guide or exclude it if you publish a Windows user guide.

In the following sections, we explain how to filter topics using the "regular" way of filtering:

But you can also filter topics using Taxonomy Filters, where you apply the filter attributes and values by dragging and dropping taxonomy tags.

Create Profiling Values

This section describes how to add a new profiling value to an attribute.

Note

In this procedure, a profiling value is added to a single procedure step to show that It is possible to Filter Inline Elements, Filter Elements and Filter Topics.

  1. Select the element in the topic.

  2. Place the cursor in the Element Structure Menu below the toolbar.

    Element_Structure_Menu_small.png

    Note

    When you select an element in the Element Structure Menu, Paligo highlights it in yellow.

  3. Select the element and choose Go to element to show the attributes for this particular element.

    Remove_element_attributes_2.png

    The Element Attributes Panel. now shows the attributes for the selected element.

  4. Select a profiling value to the right of the attribute (for example Beginner or Business).

    Remove_element_attribute_3_small.png

  5. Select Add value in the lower left corner.

    Add_Profiling_Value.jpg

  6. Enter a name for the profiling value.

    New_Profiling_Value.jpg

  7. Select OK.

  8. Check the box in front of the new profiling value to add it to the attribute.

  9. Select Apply.

  10. Select Save. Save icon.

Filter Topics

It is possible to Filter Inline Elements , Filter Elements as well as topics. If you want to filter entire topics, you need to add the profiling values to the top section element (1). This tells Paligo which topics can be filtered and what filter attributes (2) and profiling values (3) to apply. The filters are applied when the content is published, see Apply Publishing Filters.

element-attribute-value.jpg

1 = Section element, 2 = Filter attribute, 3 = Profiling value

To filter a topic:

  1. Select the topic or component in the Content Manager to open it in the Editor.

    Content Manager in Paligo. It shows the Documents section contains an Acme 100 Topics folder. Inside the folder there is a publication and many topics, including "Connect to Network (100).

    Alternatively, you can Create a Topic and edit that.

  2. Select the section element in the Element Structure Menu.

    Close up of Element Structure Menu. It shows the section element is selected and the Go to element option is selected.

  3. Select Go to element.

  4. Select Add attribute in the Element Attributes Panel.

    section-element-attributes.jpg

  5. Search for the Filter Attributes you want to use.

    Note

    Note that the Add attribute menu includes all attributes, not just filters.

  6. Select one or multiple checkboxes in front of the profiling values to be used.

    Or use Add value to create more profiling values if needed.

    profiling-values.png

    Paligo will include the topic if either of the profiling values are a match.

  7. Add as many Filter Attributes as needed.

    Note

    The filter attributes that you add will appear as Profiling attributes when you publish.

  8. Repeat this process for all topics to filtered.

  9. Select Save. Save icon.

Filter Topics for Different Markets

If you add the xinfo:market attribute to a section element to a topic, it is possible to filter a topic or publication for different markets (like America, EU, Middle East, Australia and other markets). The markets are added as profiling values. When you publish you select the profiling attribute (market) and the profiling attributes (America and EU) to be used. The markets not selected during the publish will be excluded.

Tip

To learn more about available filter attributes (for example xinfo:product, audience), see Filter Attributes .

To filter topics for different markets:

  1. Select the section element in the Element Structure Menu.

    Close up of Element Structure Menu. It shows the section element is selected and the Go to element option is selected.

  2. Select Go to element.

  3. Add the xinfo:market attribute in the Element Attributes Panel.

  4. Add one profiling value for each market.

    filter-section-euamerica.jpg

  5. Select Save. Save icon.

  6. When you publish, you choose market as profiling attribute and the profiling values to be used for the publication.

    FILTER-MARKET-PUBLISH.jpg

    • If you set the profiling attribute to North America, EU, or both North America and EU, the filtered topic is included.

    • If you set the profiling attribute 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 will be 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.

  7. Select Publish document.

Filter Topics for Different Audience

To filter topics for different audience, you add the audience attribute to the topic.

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 filter a topic for a specific audience:

  1. Select the topic or component in the Content Manager to open it in the Editor.

    Content Manager in Paligo. It shows the Documents section contains an Acme 100 Topics folder. Inside the folder there is a publication and many topics, including "Connect to Network (100).

    Alternatively, you can Create a Topic and edit that.

  2. Select the section element in the Element Structure Menu.

    Close up of Element Structure Menu. It shows the section element is selected and the Go to element option is selected.

  3. Select Go to element.

  4. Add audience attribute in the Element Attributes Panel.

  5. Select Add value to add new profiling values. Open_Settings_small.png

    profiling-values-audience-add.jpg

    Available profiling values in this case: Administrators, Engineers and Operators.

    Note

    Note that it is important to add profiling values to be able to include and exclude content.

  6. Enter a name for the profiling value.

  7. Select OK.

    Add as many profiling values as needed.

  8. Select the checkbox in front of one or multiple profiling values.

  9. Select Apply.

    filter-section-engineer.jpg

    Selected profiling values are shown in the Element Attributes Panel.

  10. Select Save. Save icon.

  11. When you publish, you choose audience as profiling attribute and the profiling values to be used for the publication.

    publish-administrators-audience.jpg

    Any topics with administrator as profiling value will be included and topics without audience as profiling attribute. All others are excluded.

Apply Publishing Filters

When you publish your content, you can choose which Filter Attributes to apply to the output. There is a field for each profiling attribute and you can set one or more values. Note that filter attributes are also known as profiling attributes.

If you choose a single value, Paligo will:

  • Include any content that has the filter attribute and the value you defined (for that filter attribute)

  • Include any content that does not have the filter attribute

  • Exclude any content that has the filter attribute, but with a different value.

If you choose multiple values, the filter works as an OR filter. Paligo will then filter like this:

  • Include any content that has the filter attribute and any of the values you defined (for that filter attribute)

  • Include any content that does not have the filter attribute

  • Exclude any content that has the filter attribute, but with a different value to the ones you defined.

When you apply filtering, it is important to understand the "inclusive" filter behavior we have described. Also, be aware that each filter attribute is handled separately. Choosing a value for one filter attribute does not mean Paligo automatically applies the same value for other filter attributes. The example at the end of this article shows how you can include and exclude content with filters.

To apply publishing filters:

  1. Select the dotted menu (...) for the topic or publication in Content Manager.

    selectpublish.png

  2. Select Publish. Publish_button_small.png

    publish-document-jan23.png

    Paligo displays the Publish document dialog.

  3. Select an Output type (PDF, HTML, HTML5, Word, XML, eLearning or SCORM).

  4. Set the Languages, Variables and Optional Parameters.

    Tip

    These are common publishing settings, see Publish Content.

  5. Select Edit in the Profiling attributes section. Filter_symbol_small.png

    Profiling attributes dialog. There are many filter fields available, including Audience, Condition, Country, and Market.

    The Profiling attributes dialog contains a field for each available filter attribute.

  6. Decide which filter attributes and values you want to apply to your publication. Then, for each filter that you want to use, select the profiling value from the menu.

    Profiling attributes dialog. The Audience filter is selected and the Beginner value is chosen.

    To learn how to create more profiling values, see Create Profiling Values.

    Note

    If there are any filter attributes that you do not want to use, leave their fields blank. When there is no attribute set, Paligo ignores that type of filter.

  7. Repeat steps 5 and 6 for each profiling attribute you want to apply.

  8. Select OK.

  9. Select Publish document to publish your content.

Example 6. Include and exclude content using an audience filter attribute

Let's say you have a publication with these topics:

The publication structure for a publication called CMS documentation. It has an Install the shield app topic, a Set your preferences topic, and a Learning the basics topic.

  • Install the shield app

    This topic is only for IT admin users.

  • Set your preferences

    This topic is suitable for all users.

  • Learning the basics

    This topic is only for beginner users.

You want to publish a help center designed for IT admin users. For this, you need to include "Install the shield app" and "Set your preferences" but exclude "Learning the basics". To make this possible, you add the audience filter attribute to the section element in the appropriate topics, and set the values as follows:

  • You give "Install the shield app" the audience attribute on the section element. You set the attribute value to:IT admin (you add a value with this name).

    Element attributes panel. The section element is selected. It has an audience filter attribute with the value IT admin.

  • You leave "Set your preferences" with the default settings. It does not need an audience attribute as this content is suitable for all users.

  • You give "Learning the basics" the audience attribute and set its value to Novice. Again, you add a value with this name and the attribute is on the section element.

    Element attributes panel. The section element is selected. It has an audience filter attribute with the value: Novice.

You then publish your content. In the publishing settings, you apply the audience filter and you choose the IT admin value.

Publish document dialog. The publishing settings are for an HTML5 help center output. The profiling attributes have Audience: IT admin set to be included.

When Paligo generates the output, it:

  • Includes "Install the shield app" as it has audience:IT admin. You chose to use content that has the audience filter attribute with the admin value.

  • Includes "Set your preferences" as this does not have the audience filter attribute. By default, Paligo includes any content that does not have the filter attributes you chose to use.

  • Excludes "Learning the basics" as it has the filter attribute, but it does not have admin as the value. Instead it has novice, which does not match your filter criteria, and so the content is excluded.

HTML5 Help Center output. It has panels and links for the Install the shield app and Set your preferences topics. There is nothing for the Learn the basics topic as it has been filtered out of this publication and is not included.

Add or Remove Profiling Values

Paligo uses a blue filtering symbol to show that content has a profiling attribute, see Filtering / Profiling.

This section describes how to add or remove a profiling value from an attribute. A removed profiling value will not be deleted, only not used on the attribute.

  1. Select the element in the topic.

  2. Place the cursor in the Element Structure Menu below the toolbar.

    Element_Structure_Menu_small.png

    Note

    When you select an element in the Element Structure Menu, Paligo highlights it in yellow.

  3. Select the element and choose Go to element to show the attributes for this particular element.

    Remove_element_attributes_2.png

    The Element Attributes Panel. now shows the attributes for the selected element.

  4. Select a profiling value to the right of the attribute (for example Beginner or Business).

    Remove_element_attribute_3_small.png

  5. Use the checkboxes in front of the profiling values to decide whether to use it on the attribute or not.

    • Check the box to add it to the attribute (for example Expert).

    • Clear the box to remove it from the attribute (for example Beginner or Business).

    Add_Remove_Profiling_values_small.png

    Available profiling values are shown.

  6. Select Apply.

  7. Select Save. Save icon.

Edit or Delete Profiling Values

You can edit or delete a profiling value if needed. Before you do, make sure that all content that uses it is checked in. To find topics that use a specific profiling value, see Search for Attributes.

If you regularly delete outdated profiling values, it will be easier to know which ones to use.

Note

When a profiling value is deleted it will be removed from all content that uses it. The action is irreversible.

Tip

If you only want to deselect a profiling value from an attribute, see Add or Remove Profiling Values.

To edit the name or delete a profiling value:

  1. Select the element in the topic.

  2. Place the cursor in the Element Structure Menu below the toolbar.

    Element_Structure_Menu_small.png

    Note

    When you select an element in the Element Structure Menu, Paligo highlights it in yellow.

  3. Select the element and choose Go to element to show the attributes for this particular element.

    Remove_element_attributes_2.png

    The Element Attributes Panel. now shows the attributes for the selected element.

  4. Select a profiling value to the right of the attribute (for example Beginner or Business).

    Remove_element_attribute_3_small.png

  5. Hover over the profiling value to be edited or deleted.

    Delete_or_Edit_Profiling_Value.jpg

  6. Select one of the options to the right of the profiling value:

    • Delete_small.png Select the X to delete the profiling value from your Paligo instance. You will need to confirm the deletion.

    • Comment_small.png Select the pen to edit the name of the profiling value.

  7. Select Apply.

  8. Select Save. Save icon.

Related articles

Comments

0 comments

Article is closed for comments.

Powered by Zendesk