2.14 Field Help Text
HELP text is information that is displayed to the user when the HELP key is used.
Generally Field Help text has these characteristics:
- It is free format. No restrictions usually exist on the content or format of HELP text.
- It relates directly to the action the user was taking at the time the HELP key was pressed. Usually the process or function that the user is using is explained in some detail.
- Quite often the fields on the screen that were on display when the HELP key was pressed are each described in detail. Part of the description usually involves the name and description of the field, any validation rules that apply to its input and comments on the use and interpretation of the field's value.
LANSA automatically controls the handling of the HELP key. In addition LANSA will automatically determine the type of HELP that is required (field, process or function) and automatically display the associated HELP text (if any exists).
LANSA can dynamically, and in the correct language, create the HELP text associated with a field from the dictionary and the rules that it contains. You can turn off this automatic field level help text feature globally, by field, or precede it with your own HELP text.
What LANSA cannot do is create the free format HELP text that is associated with the processes or functions. This is generally the task of the person who creates the process or function.
These sections deal with how HELP text is entered for fields. For details of how HELP text is entered for processes or functions refer to the Process and Function sections.
Once the HELP text has been entered LANSA will automatically display it at the appropriate time.
The actual method used to display HELP text is described in some detail in the Messages and the Help Key.
How to use LANSA's Help text features is described in the following topics:
2.14.1 Steps to Create, Review or Change HELP Text
2.14.3 Use the IBM Source Entry Utility (SEU)
2.14.4 Use Special Characters to Enhance HELP Text
2.14.5 Use Substitution/Control Values in HELP Text
2.14.6 Substitution/Control Values for Windows-specific HELP Text
2.14.7 Use IBM i Office Help Documents
2.14.8 Exit from the SEU Utility
2.14.9 Use Panel Groups for Help Text