Adding context-sensitive help for a part
To provide context-sensitive help for a part, you simply specify the help information in the settings for the part.
To do this for a part in your application, open its settings. Specify values for the part's help properties as follows:
helpFile
Type the name of the help file. You do not need to specify the file extension.
In Windows, use the PATH or the HELP environment variable to locate the named help file.
In UNIX systems, use the DTHELPUSERSEARCHPATH environment variable.
For HTML-based help the parameters in abt.ini specifies the location of the named helpFile. The name of the helpfFile must be prefixed by with HTML: ; the file extension is hlp .
helpTopicId
Type the ID you specified in the help source for the related help panel.
For Windows help files, the Topic ID must match the numeric value in the project file's [MAP] section that is associated with the help panel ID.
For UNIX, the Topic ID must match the value specified for the id attribute of a heading.
For HTML-based help the map file is the file specified in the helpFile attribute is used as a map file. The contents will consist of one or more lines containing an integer (the topic ID) and a file name. The location of the file name is determined by HelpDocs in abt.ini
For instance, the help file could contain
1 test42018.html.
10251 db/dbconsfrm.htm#HDRGENDATAB
The first line has a simple file name; the second specifies a subdirectory, db and a location, HDRGENDATAB in the file dbconsfrm. If the TopicID were 1, then context sensitive help would try to locate the file test42018.html.
helpKeysId
Type the ID you specified in the help source for the related help panel on a key. For HTML-base d help this setting has no effect.
helpTitle
For Windows and UNIX systems, this setting has no effect. You specify the title of the main help window in the help project file. This setting was used for OS/2 to specify the name to appear in the title bar of the main help window.
Now, test the help file by, for example, pressing the F1 key while the main help window's focus is on a part that has context-sensitive help.
Last modified date: 01/29/2015