Previous Topic: Displaying Help TextNext Topic: Contextual (Cursor-Sensitive) Help Text


Indexing Help Text

The Toolkit help text display has an index facility that can automatically provide an index to a help text document. An index will be provided if ‘index entry’ lines, that is, lines containing the Toolkit index control characters (‘. *YI:’) are present at the beginning of a help text document. Each Toolkit ‘. *YI:’ line must contain a label; the same label must also be present on a Toolkit label entry line (‘. *YH:’) later in the document.

The following figure illustrates the use of indexing. It shows the actual text source lines necessary to produce an index.