##### 3.2.1.4 Providing help for your own format and macro definitions

The Configuration Manager displays one-line descriptions of all fixed-name configuration sections, including all format and format component definitions and all macro definitions supplied in the DITA2Go distribution.

For definitions of formats and macros that you create and name, by default the Configuration Manager displays:

No Help for this section

Help for format definitions

To provide descriptive help for a format, include a setting in the definition of that format for keyword help, and supply descriptive text as the value; for example:

    [OverTitle]
    based = PrefaceTitle
    help = Format for title of Overview topic

Help for macro definitions

To provide descriptive help for a macro, prefix keyword help with special comment delimiters ;= to keep it from being parsed as part of the macro. For example:

    [AnotherURL]
    ;=help = The URL for the DTS project at SourceForge
    http://sourceforge.net/projects/ditatestsuite

Previous Topic: 3.2.1.3 Getting help with controls and configuration data

Next Topic: 3.2.1.5 Correcting configuration errors

Parent Topic: 3.2.1 Understanding how to use the Configuration Manager

Sibling Topics:

3.2.1.1 Drilling down to find a section or setting

3.2.1.2 Heeding status and result messages

3.2.1.3 Getting help with controls and configuration data

3.2.1.5 Correcting configuration errors

Table of Contents • Index