7.4.3 Documenting output formats

To make it easy to identify and locate format definitions, you can assign values to two format meta properties:

[FormatName]
category = CategoryName
help = Any text to remind you of the nature and purpose of the format

The value for category must be the name of one of the format subcategories defined in the Configuration Manager. See §3.2.5 Choosing a configuration category or file type. However, if you have named your format according to the suffix requirements described in §7.4.1 Naming output formats, you do not need to include a category setting in the definition; the Configuration Manager will deduce the category from the suffix.

The value for help can be any text that will help you remember what the format is for. The Configuration Manager displays help text for every format.

Previous Topic:  7.4.2 Assigning values to format properties

Next Topic:  7.4.4 Understanding the basis of format properties

Parent Topic:  7.4 Understanding how to define output formats

Sibling Topics:

7.4.1 Naming output formats

7.4.2 Assigning values to format properties

7.4.4 Understanding the basis of format properties

7.4.5 Basing format properties on other formats

7.4.6 Modifying DITA2Go default output formats

7.4.7 Applying CSS and RTF code to output formats

7.4.8 Assigning content-adding properties to formats

Table of ContentsIndex