

User Access Utilities › Introduction › Displaying Help Text › Naming Help Text Documents
Naming Help Text Documents
Give careful consideration to the names for help text documents. Factors to consider include:
- The default document name used by the Toolkit program Go to Menu (YGO). If no help text member is specified for an option, the default help text document name used by the menu program is the name of the program or command specified for the option. It will save you coding effort if you give a help text member the same name as that of the program or command that it explains.
- How to associate programs with their help text. The standard help text call included in application programs can use the program name (retrieved from the Program Status Data structure) as the help text document name, to save coding effort.
- How the documents will be grouped when they appear in indices. It helps to have documents grouped in a logical order. If you already give your programs names that cause them to be grouped in a logical order on indices, then it would be sensible to give each help text document the same name as the program that it explains.
Note: You should give a help text member the same name as the command or program for which it gives an explanation.
Copyright © 2014 CA.
All rights reserved.
 
|
|