Book filtering for software releases

Object Variants

When you're working in a book, use the filter to view and then work in your chosen variants. You can filter the book and see the content that will be used for each "flavor" of the document. In addition, you can filter the book and then publish - the criteria values you selected in the book will be automatically applied to the publishing filter.

Find out more about displaying the book's variant filter.

Book Filtering Overview for Software Releases

Objects with strikethrough text

One of the options for working with variants for software releases is the option to assign filter criteria to a topic to mark its introduction into the book. Let's say the topic is introduced in release 1.2. When you filter the book for an earlier release you'll notice the object is displayed using strikethrough text. Although the topic is displayed in the contents pane it is not included in the published output.

What do the filtering results mean?

Let's look at an example where a book is filtered for release 1.1. The content shown is based on the best match available for the selected criteria value. The criteria values are shown in the Release column.

Filter Results


A variant is found for the current build


There is no variant for the current build, but a variant was found for an earlier build


A variant was found for content deleted from the current build - the topic will not be included in the published output for this release. The topic is based on a non-publishing template.


A variant is included in the book for a future release - the topic is displayed using strikethrough text and will not be included in the published output


Standard objects are used in the book for content that does not change from one release to the next. This means there are no variants of these objects, such as the front matter topics and the introduction sub book