2 14 5 Use Substitution Control Values in HELP Text

You are here:

2.14.5 Use Substitution/Control Values in HELP Text

LANSA provides a set of "substitution" and "control" values that be included into HELP text to control and enhance its display to the user.

HELP text substitution/control values are substituted/actioned at execution time (i.e. when the HELP text is being actively displayed to a user).

Note: These values must be entered in uppercase in the HELP text.

Substitution Value	Description, Effects And Comments
$$PAGE	Causes the string "Page: 999" to be inserted into the text. Use to indicate the current HELP text page number to the user.
$$NEWPAGE	Causes a new HELP text page to be started. A HELP text page is 18 lines long by default. The line containing the $$NEWPAGE value is included into the displayed HELP text. The $$NEWPAGE value is replaced by blanks.
$$TITLE XXXXXXXX	Indicates to LANSA the title that should be associated with the HELP text. Up to 40 characters of title can be specified. LANSA will automatically center the title and convert it to uppercase. The line containing the $$TITLE value is NOT included into the displayed help text.
$$FLDNAM	Causes the name of the current field to be inserted into the HELP text. Use this value in field level HELP text only.
$$FLDDES	Causes the description of the current field to be inserted into the HELP text. Use this value in field level HELP text only.
$$COMNAM	Causes the name of the current component to be inserted into the HELP text. Use this value in component level HELP text only.
$$COMDES	Causes the description of the current component to be inserted into the HELP text. Use this value in component level HELP text only.
$$PRONAM	Causes the name of the current process to be inserted into the HELP text. Use this value in process or function level HELP text only.
$$PRODES	Causes the description of the current process to be inserted into the HELP text. Use this value in process or function level HELP text only.
$$FUNNAM	Causes the name of the current function to be inserted into the HELP text. Use this value in function level HELP text only.
$$FUNDES	Causes the description of the current function to be inserted into the HELP text. Use this value in function level HELP text only.
$$RIGHT	Causes all manually defined help text to be right aligned when displayed. This support is provided for bi-directional languages.
$$NOAUTO	Indicates that automatically generated help text should not be created for this field. Use this option in field level help text only.
$$LANGUAGE=XXXX	Delimits the boundary between the help text associated with different languages when working in a multilingual partition. These values are automatically created when editing help text and should not be altered in any way or the help text associated with a language may be corrupted.
$$TECH	Indicates that the following text is technical help text. This help will only be displayed to a developer within LANSA.
$$USER	Indicates that the following text is user help text. This help will always be displayed within LANSA. Help text will default to user help text if no $$TECH value is used.