DtkshDisplayQuickHelpDialog and DtkshDisplayHelpDialog

These convenience functions create a single instance of each of the help dialogs. If an instance of the requested type of help dialog already exists, then it is reused. The parent of the dialog is obtained from the environment variable $TOPLEVEL, which should be set by the calling shell script, and then should not be changed. The handle for the requested dialog is returned in one of the following environment variables:

• _DTKSH_HELP_DIALOG_HANDLE

• _DTKSH_QUICK_HELP_DIALOG_HANDLE

If it is necessary to destroy a help dialog, then be sure to clear the associated environment variable so that the convenience function does not attempt to reuse the dialog.

Usage:

DtkshDisplay*HelpDialog title helpType helpInformation [locationId]

The meaning of the parameters is dependent upon the value specified for the helpType parameter. Their meanings are:

• helpType = HELP_TYPE_TOPIC

  • helpInformation = help volume name

  • locationId = help topic location ID

• helpType = HELP_TYPE_STRING

  • helpInformation = help string

  • locationId = <not used>

• helpType = HELP_TYPE_DYNAMIC_STRING

  • helpInformation = help string

  • locationId = <not used>

• helpType = HELP_TYPE_MAN_PAGE

  • helpInformation = manual page name

  • locationId = <not used>

• helpType = HELP_TYPE_FILE

  • helpInformation = help file name

  • locationId = <not used>

Example:

DtkshDisplayHelpDialog "Help On Dtksh" HELP_TYPE_FILE       
               "helpFileName"