|
Creating Conditional Text |
The feature ‘Conditional Text’ allows you to conditionally include or exclude a section of text or an entire topic based on a Boolean condition. This feature is especially useful if you generate more than one set of help files from a single help document. For instance, you can generate two help files for software that you distribute as a ‘Full’ and as a ‘Lite’ version. The ‘Full’ version of the software includes a help file with all topics, while the ‘Lite’ version of the software contains only selected topics.
Creating a conditional text is a two step process. First you need to create a ‘build-tag’. A ‘build-tag’ is a conditional tag that you can apply to one or more topic pages or to sections of text. If the Boolean condition for the build-tag evaluates to True, all topics or sections of text with this build-tag are included in the help file. Topics that do not have any build tags applied to are always included in the help file.
In the above example, you would create a ‘Lite’ and a ‘Full’ build-tag. All topics that should only be included in the ‘Lite’ version of the help file must have the ‘Lite’ build-tag applied to. All topics that should only be included in the ‘Full’ version of the help file must have the ‘Full’ build-tag applied to. All topics that are shared by the two help files should not have any of the two build tags applied to. When you create the help project, set the build-tag ‘Lite’ to true and the build-tag ‘Full’ to false when you build the ‘Lite’ version of the help file. Set the build-tag ‘Lite’ to false and the build-tag ‘Full’ to true when you build the ‘Full’ version of the help file.