Design and test conditional text

1)Determine the types of output needed, such as printed manuals or online tutorials; consider current and future requirements. Determine whether versions for different skill levels are required.

2)Determine which conditional build tags to apply to each output type. All untagged compo­nents are included in the output. Determine whether to apply multiple tags to topics, for varied output types. For example, to deliver a manual for testers of beta software, tag the beta-specific topics with a tag such as Beta. Tag the other topics with a tag such as Printed. Then you can include beta-related topics first, and exclude them later.

3)Use the Topic Properties report or the Conditional Build Tag report to review the tags applied to each topic.

4)Determine whether to apply a conditional build tag to the entire topic or to one or more areas within a topic. For example, if you are creating a printed manual, exclude text that mentions an online glossary.

5)Decide on tag names and colors, especially if the project is large and requires multiple output types. Define tag names that describe the output, such as Print or Online. Tag colors help you differentiate conditional text areas within a topic.

6)When updating a project, determine whether to delete content that is made obsolete by single-sourcing and conditional output. For example, a project contains text (such as “for advanced users”) or images that explain which content applies to which users. You can delete these elements or use conditional text to hide them in the output.

7)Determine which TOCs or pages of a TOC to include in the output, as you apply each tag.

8)Determine which indexes to include in the output. You can create multiple indexes in a project and include each one in the appropriate output.

9)Test the conditional tags by generating the output and viewing the results. Exclude combina­tions of tags you applied to topics, TOCs, or indexes. You can also preview topics, without generating, to experiment with conditional areas.


September 30, 2016

Legal Notices | Online Privacy Policy