Skip to main content

Types of Filter

There are many different types of filter that you can use. Some are defined by the DocBook standard and some are custom filters created for Paligo. They are also called "filter attributes", as you can add them to your content as attributes for your elements.

You need to decide which filter attributes you are going to use in your content. You will also need to create the filter values for them.

Note

For filters that you are going to apply to entire topics, we recommend that you use taxonomy tags for filtering. You will need a taxonomy tag to represent the filter attribute and separate child taxonomy tags for each filter value.

For filters that you are going to apply to elements inside a topic, you can only use filter attributes. You apply those from the Element attributes panel.

The following table shows the different filter types.

Filter attribute

Source

Description

arch

DocBook

Filter by computer or chip architecture.

audience

DocBook

Filter the content based on the intended users, for example, internal staff or customers. You could use audience for the knowledge level too, such as beginner or expert. But there is a userlevel attribute specifically for that, so can use audience or userlevel, but it is important to be consistent.

condition

DocBook

This is a general-purpose filter attribute. Use this filter if the other filters do not meet your requirements.

conformance

DocBook

Filter by conformance standards.

os

DocBook

Filter by operating system, for example, Windows.

outputformat

DocBook

Filter by the type of output, for example PDF.

revision

DocBook

Filter by publication revision, for example, v.3.1.

security

DocBook

Filter by security level, for example, Low.

userlevel

DocBook

Filter by knowledge level of the intended audience, for example, expert.

vendor

DocBook

Filter by product provider, such as a manufacturer or seller.

xinfo:country

Paligo

Filter content by the country (for example USA) that the documentation is designed for.

xml:lang

Paligo

Filter by natural language, for example, filter Swedish content. This filter attribute is a special case, as there is a different process for using language filters. To find out more, see Filter by Language.

xinfo:market

Paligo

This is similar to x:info:country except that it is less geographically rigid, for example, you can filter for the Asian market or the North American market.

xinfo:product

Paligo

Filter by product name or model.

xinfo:proglang

Paligo

Filter by programming language or to publish to API style "on-the-fly" filtering HTML5.

Paligo does not support using xinfo:proglang on table rows.

xinfo:version

Paligo

Filter by version. You can use this in combination with the version management features of Paligo, but this is not a requirement. The usage is up to you.