Using CA IDMS Masterkey › Online Documentation Support › Structuring Online Documentation

Structuring Online Documentation

Online documentation must be structured as follows:

1. In Column 1, specify "PAGE title" where title describes the subject of the online documentation. See Exhibit 2.3.
2. Enter the text.
3. If the text spans more than 21 lines, the online documentation processor creates a CONTINUED page, or you can specify another PAGE clause to directly control page formation.
4. Toggle highlighting off and on with the cent (&cent.) sign. In Exhibit 2.3, for example, the command and the numbers 1, 2, 3... would be highlighted.

Refer to source member MKHELP supplied on the installation media for additional examples of online documentation usage.

 PAGE 'PF4 HELP'

The command on this line is:

 ¢CLIST LEVEL_ONE PROMPT @1 @2 @3 @4 @5¢

This executes a nested CLIST with variables as follows:

 ¢1¢DCUF TEST Version Number
 ¢2¢Another DCUF TEST Version
 ¢3¢Yet another DCUF TEST Version
 ¢4¢Operand of a DCMT D AC Command
 ¢5¢Operand of a DCMT D LI Command

Exhibit 2.3: PF Key-Specific Online Documentation Example