Common Desktop Environment: Help System Author's and Programmer's Guide

For Programmers

  1. The application sets the correct values for these required resources:

    App-class*helpVolume:        volume
     App-class*helpOnHelpVolume:  help-on-help-volume 

    The helpVolume resource identifies the help volume for your application.The helpOnHelpVolume identifies the help volume that contains the help on using the help system.

  2. Execution aliases are included in the application defaults file.

    An author defines execution aliases as application resources. An execution alias associates a name with a shell command to be executed. If execution links have been used in the help volume, check with the author to identify the resources that need to be added. For more information, refer to "Execution Aliases".

  3. The application sets the desired values for the following optional resources:

    App-class*DtHelpDialogWidget*onHelpDialog*rows:     rows
     App-class*DtHelpDialogWidget*onHelpDialog*columns:  columns
     App-class*DtHelpDialogWidget*definitionBox*rows:    rows
     App-class*DtHelpDialogWidget*definitionBox*columns: columns 

    The onHelpDialog resources control the size of the quick help dialogs used to display Help on Help. The definitionBox resources control the size of the quick help dialog used for definition links.

  4. The application uses either the default font resources or defines font resources in the application's application-defaults file.

    In most cases an application can rely on the default font resources. However, when custom fonts are used, they must be defined in the application-defaults file. Sample font schemes are provided in the /usr/dt/dthelp/fontschemes directory. See Chapter 14, Native Language Support, for additional information about font schemes.