4.8.7 Substitution/Control Values for Windows-specific HELP Text
These help text substitutions are used to link help for other objects to the automatically generated Index (& Contents) for the current object. They do not produce visible entries in the generated help text.
Note that the Contents are only produced for the new help interface provided with Windows.
|
Substitution Value |
Description, Effects and Comments |
|
$$INDEXFLD = <field-name> |
Causes an item to be included in the Index that will display help text for the designated field. The rest of the current line is ignored. The label used in the Index is the field's description. |
|
$$INDEXCOM = <object-name>, <component-name> |
Causes an item to be included in the Index that will display help text for the designated component. The component is specified using the owning object (e.g. form) and component names, separated by a comma. The rest of the current line is ignored. The label used in the Index is the component's name. If no component name is specified then the index item will display help for the object (e.g. form) itself. |
|
$$INDEXPRO = <process-name> |
Causes an item to be included in the Index that will display help text for the designated process. The rest of the current line is ignored. The label used in the Index is the process's description. |
|
$$INDEXFUN = <process-name>, <function-name> |
Causes an item to be included in the Index that will display help text for the designated function. The function is specified using the owning process and function names, separated by a comma. The rest of the current line is ignored. The label used in the index is the function's description. |
|
$$ROOT |
Causes any following Index substitutions ($$INDEX…) to be added to the root of the Contents tree-view. Useful for index items that might be applicable to all or a number of topics. |
|
$$LEAF |
Causes any following Index substitutions ($$INDEX…) to be added below the current topic in the Contents tree-view. This is the default value and only needs to be specified to switch back after $$ROOT has been used. |
|
$$IMAGE = <filename>, <alternate-text> |
A bitmap (*.BMP) image file to be included in the help text at this point. The image is centered in the screen. The default path is the current partition's Execute directory, but any path may be specified. Note: Universal Naming Convention (UNC) paths are not supported. The alternate text is used instead of the image in an interface where images are not displayed, such as a 5250 terminal. If the alternate text is not specified then the filename is used instead. |