User's Guide

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 OS/2, the current directory and the directories specified in the HELP environment variable are used to locate the help file.

In Windows, use the PATH environment variable.

In UNIX systems, use the DTHELPUSERSEARCHPATH environment variable.

helpTopicId
Type the ID you specified in the help source for the related help panel.

For OS/2 help files, the Topic ID must match the number specified in the panel's heading tag res= attribute (or the string specified in the id= or name= attribute).

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.

helpKeysId
Type the ID you specified in the help source for the related help panel on a key.

helpTitle
For OS/2, type the name you want to appear in the title bar of the main help window. Or, leave this field blank and get the default help title, "Help Window."

For Windows and UNIX systems, this setting has no effect. You specify the title of the main help window in the help project file.

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.


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]