Articles in this section

See more

Filter Attributes and Filter Values

Avatar
Anders
  • Updated
Follow

To apply filters to the elements inside a topic, use filter attributes and filter values. These tell Paligo the filter properties of the content.

  • Filter attribute defines the type of filter

  • Filter value(s) define the condition(s) that apply to the content.

For example, you could have a para element with a market attribute and Europe as the filter value. When you publish, you could choose to include the market attribute but only when its value is USA. This would result in Paligo excluding the paragraph from your topic, as your paragraph has market:Europe.

Element attributes panel. A para element is selected and it has an xinfo:market filter attribute with Europe as its filter value.

You have to use attributes and values for filtering content inside topics. You cannot use taxonomy tags to filter block elements.

To use filter attributes and values:

  1. Decide which filters you are going to use (see Types of Filter).

  2. Make sure that you understand how filters work when used on hierarchical structures (see Filters on Hierarchical Structures).

  3. Open a topic in the main editor and apply the filter attributes and filter values (see Apply Filter Attributes).

    You may need to add filter values to the Paligo database (see Add the Filter Values).

    Note

    You can set up the editor to preview how your filters will work (see Preview the Filter Effects).

  4. Repeat the previous step for your other topics.

  5. Publish your content and choose which filters you want to apply ( see Choose Which Filters to Apply When Publishing). Depending on your choices, Paligo will include or exclude the content you have marked up for filtering.

Apply Filter Attributes

To apply filters to content inside your topics, such as paragraphs, use filter attributes and filter values. By adding them to block elements, you "markup" the elements so that Paligo can include them or exclude them when you publish.

Tip

Before you apply filter attributes, be aware that filters work hierarchically. For example, you can't set a cell in a table to be included if the overall table structure is excluded. To learn about the hierarchical relationships, see Filters on Hierarchical Structures.

To apply filter attributes:

  1. In the Content Manager, select the topic you want to edit.

    Alternatively, create a new topic and edit that.

    Paligo opens the topic in the main editor.

  2. Select the block element that you want to filter.

    For example:

    • Select a para element to filter a single paragraph

    • Select a step element to filter a single step in a procedure

    • Select an iitemizedlist element to filter an entire bullet list

    • Select a top-level section element to filter an entire section (topic)

    • Select an article element in a publication topic if you want to filter an entire publication.

    Note

    To filter an inline element, you need to add the phrase element and move the inline element inside it. You can then apply the filter to the phrase element and it will also apply to the inline element, due to the hierarchical relationship.

    For more details, see Filter Inline Elements and Filters on Hierarchical Structures.

  3. Make sure that the correct element is shown in the Element attributes panel.

  4. Select Add attribute and search for the filter attribute that you want.

    For a list of the available filter attributes, see Types of Filter.

  5. Select a filter attribute.

  6. Apply the filter values:

    Profiling values dialog for xinfo:market. It shows checkboxes for three values, Asia, Europe, and USA. There is a search box for searching for values. There is also an Add value button, a cancel button and an apply button.

    • Check the boxes for the filter values that you want.

    • Select Add Value to create a new filter value for the selected filter attribute. Enter the new filter value and then select OK. Then check the box for the new value to apply it.

    • Select Apply to use the filter values you have selected.

  7. Repeat steps 2-6 inclusive for each element that you want to filter.

  8. Select Save. Save icon.

Repeat this process for each topic that contains elements that you want to filter.

When you have applied your filter attributes and filter values, you can choose which filters to apply when you publish.

Filter Inline Elements

Use the phrase element to apply filters to inline elements. This is useful when you need to filter part of a block element, for example, if you wanted to filter one sentence in a paragraph rather than the entire paragraph.

To filter inline elements:

  1. Select the content you want to filter.

    A topic containing a title, a paragraph, and a procedure with 3 steps. A callout arrow points to a sequence of 3 words in a step. The 3 words are highlighted to show they are selected.

  2. Press Alt + Enter ⏎ (Windows) or Command ⌘ + Enter ⏎ (Mac) to display the Element Context Menu.

    Element context menu shows a search field and a list of elements that are valid at the current position.

  3. Enter phrase and select it.

    Paligo inserts your selected content into the phrase element.

  4. Click in your selected content so that the phrase element is shown in the Element Structure Menu.

    A topic containing a title, a paragraph, and a procedure. There is a callout arrow pointing at a sequence of three words in one of the steps. The three words have arrow icons around them to show they are inside an inline element. Another callout arrow points to the phrase element in the Element Structure Menu. It shows that the inline element around the highlighted 3 words is a phrase element.

  5. Add the filter condition that you want to apply to the phrase In the Element Attributes Panel.

    This works in the same way as filtering any other element, for example, you could set an xinfo:country attribute if you wanted to be able to include/exclude the phrase based on the country. To find out about the range of filters available, see Types of Filter.

    Element attributes panel. The phrase element is selected and it has been given an xinfo:country filter with the value set to USA.

  6. Set the value for the filter and apply it to your phrase element.

    To find out about filter values, see Add the Filter Values.

  7. Select Save. Save icon.

When you publish, you can choose which filters to apply to your content. As the inline content is now wrapped in a phrase element, it can be filtered in the same way as any other element. The settings you choose when you publish will determine whether the phrase is included or excluded from the published content.

Preview the Filter Effects

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

To preview the filters:

  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 Preview tab in the Toolbar.

    Preview_menu_small.png

  3. Select Profile settings. Profile_settings_button_small.png

  4. Select the Profiling tab.

    Profile settings dialog. The Profiling tab is selected. It has a field for each different type of filter attribute.

    The Profiling tab shows a list of filter attributes that you can use. By default, each filter attribute has no value and so there are no filters in place.

  5. For each filter attribute that you want to use, choose a filter value.

    Profile settings dialog. The Profiling tab is selected. The Market attribute has a value of Europe and the Product attribute has a value of ACME 2000.

    If you don't want to apply a particular filter, leave its value field empty.

  6. Select Apply.

    Paligo updates the topic to show the filters that will be used with the variant you have selected.

    The preview:

    • Includes content that is not marked up to use the filter attributes you have chosen.

    • Includes content that is marked up to use filter attributes and filter values you have chosen.

    • Excludes content that is marked up to use the filter attributes you have chosen, but with different values.

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

Tip

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

Example 3. Preview the effects of a market filter on a single paragraph

Let's say you want to filter a paragraph so that it only appears when the document is published for the European market. You select the appropriate para element and give it the xinfo:market attribute and set the value to Europe.

A topic in the main editor. It has three paragraphs. The last paragraph has an xinfo:market filter attribute with a filter value set to EUROPE.

Before you publish, you want to preview the filter. So you go to the Profile settings in the editor and set Market to Europe and then select Apply. The paragraph remains in view in the topic, as it has the market attribute with a value of Europe.

A topic in the main editor. It has three paragraphs. The last paragraph has an xinfo:market filter attribute with a filter value set to EUROPE. The preview panel is open and has the filter set to Market:EUROPE.

You return to the Profile settings and change the filter to Market with a value of USA and then select Apply. The result is the paragraph is no longer shown in your topic.

A topic in the main editor. It has three paragraphs. The last paragraph is missing and there is an empty filter box. The preview panel is open and has the filter set to Market:USA.

This is because:

  • You have set the Profile preview to include (show) content that has the Market filter with a value of USA.

  • The paragraph has the Market filter, but does not have the value USA.

  • The other content is shown as it does not have the Market filter at all.


Related articles

Comments

0 comments

Article is closed for comments.

Powered by Zendesk