Using include options gives you very fine control over what you include and exclude in your published output. You can "tag" chapters, topics and content within your topics with include options.
When you generate your output you then select the corresponding include options in the Publish options to include or exclude the items tagged with those options from your published output.
You can tag both topics and content within topics with include options. •Topics are tagged with Change > Include in Builds in Project > Manage Topics. •Content is tagged with the |
There are two different kinds of include options, those based on your publishing format and those defined by the user. The format-based options are used to create different versions on the basis of your output format – for example alternative text for the PDF version. The user-defined options are used to create fundamentally different versions of your project – for example for different versions of your product or for different customer groups. Format-based include options:These include options are predefined. They correspond to the output formats supported by Help & Manual. For example, if you tag an item or topic content with the HTML Help option it will only be included when you publish to HTML Help. User-defined include options:These include options are conditions that you define yourself. You can define as many of them as you want. You can tag text and topics with them in exactly the same way as with the format-based options. They are defined in Configuration > Common Properties > Custom Builds. When you tag content with a user-defined include option it will only be included in your output if you activate the corresponding option in the Publish options. Otherwise it will be excluded. |
In addition to include options you can also control and vary your output with variables, HTML template conditions and modular projects. For more background information see the Variables & Conditional Output chapter in the reference section and the Working with Modular Help Systems chapter. |
It is crucial to understand is that conditions use OR logic. This means that only one condition needs to evaluate true to include or exclude the content it refers to. If multiple conditions are true the corresponding content will also be included but only one condition is needed to enable inclusion. This means you need to be careful with tagging using multiple conditions. For example, if you tag a topic for both CHM (HTML Help) and TEST_BUILD you will never be able to exclude that topic from your HTML Help output, because the CHM tag will always include it. Topics and chapters:•By default, all new topics are tagged with the option ALL Builds. This means that they will always be included. •If you tag a topic with a format condition (e.g. CHM) that topic will only be included in that output format. •If you tag a topic with a format condition (e.g. CHM) and a user-defined condition (e.g. TEST_BUILD) that topic will always be included in the matching output format. In addition to that, it will also be included in any other output formats when you activate the corresponding include option in the Publish options. •IFNOT simply reverses the logic – IFNOT CHM includes content in all formats except HTML Help. Content in topics•By default all topic content is included in all output unless it is explicitly excluded with conditional text tags. •Tagging content with a format condition only includes that content in that output format. •Tagging content with a user-defined condition only includes that content when the matching condition is activated in the Publish options. •Here too, IFNOT reverses the logic – IFNOT HTML includes the tagged content in all formats except WebHelp. |