4.4 Component Help Text

Component help text can be stored within the component definition (refer to DEFINE_COM) or it can be stored in the repository with field, function and process help.

Help text is information that is displayed to the end user when application requests help (using the Help key or equivalent request). Help text can be entered for each language specified in the partition.

Generally, Help text has the following 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 was requested. Usually an overall description of the component that the user is using is presented.
• Help text may also include special Help Text Enhancement & Substitution Values.

LANSA automatically controls the handling of the Help processing in applications. LANSA will automatically determine the type of Help that is required (field, component, process or function) and automatically display the associated Help text (if any exists).

Also See

In the Developer Guide: Repository Help Editor

In this guide:
Substitution/Control Values
Substitution/Control Values - Visual LANSA Only
Help Text Attributes.