Filtered Catalog

Experimental feature

Enable it on the homepage in the «Experimental Features» block.

Filtering is used when you need to create multiple documentation builds from a single catalog — for example, builds by reader role or product type. You can filter both articles and individual paragraphs of text.

Create a filter

First, create a property that will be used for filtering, and select its type: «Flag», «One from the list» or «Several from the list».

The values of this property will determine which articles and paragraphs are included in the build. The selected filter value is also displayed in the catalog URL on the reading portal.

For example, for a catalog with technical specifications, you can create properties for operating systems:

  • Windows

  • MacOS

  • Linux

After this, specify these properties in the catalog settings.

Set filters

On articles

For all articles in the catalog, you must specify the property that indicates in which builds the article will be shown.

  • The filter is not inherited: you must set it for the section and for all articles within that section.

  • If no filter is specified, the article will not appear in any build.

  • If an article should be included in all builds, you must specify all filters.

The article appears in the Windows and macOS builds, not in Linux

On paragraphs

You can split paragraphs within an article so they appear only in the required builds. To do this, create tabs and name them exactly according to the property values in the articles.

  • If a tab name differs from a filter name («macOs» instead of «MacOs»), filtering will not work.

  • If there is only one tab, it will appear only in one build.

Enable the filter

You can check content filtering right in the application: in the right-hand panel, click «Filter» and choose the build name. The filter can be enabled in the application and on the reading portal. The selected filter is added to the catalog URL.

Export with filter applied

Export to PDF or DOCX takes the selected filter into account. Only the filtered articles and paragraphs will be included in the file.

Known limitations

The «Filtered Catalog» and «Publish to Gramax Cloud» features are experimental. If you publish a catalog to Gramax Cloud, you must set window.localStorage.setItem("enabled-features", "filtered-catalog") in the portal console — only after that will the filters become available for switching. There is no such limitation if you publish the Documentation portal using Docker or as a static site.