Step 5: Putting the Help Files in the Registration Package

For an example of adding help files to a registration package, see Step 5 of Example of Creating a Registration Package.

If the application includes a desktop help volume (a help volume created with the desktop Help Developer's Kit), the help volume master file (*.sdl) should be placed in the directory app_root/appconfig/help/language.

Graphics used by the help files are usually placed in a graphics subdirectory. The graphics must be located in the same directory relative to the master help volume (*.sdl) file as when the help volume was created.

If the application does not provide a help volume, you can create one if you have the Help Developer's Kit.

There are two levels of integration of a help volume:

• Full integration.

  When desktop help is fully integrated, the help volume can be accessed from the application—for example, by on-item help and the Help menu. Full integration involves modification to the application's executables.

• Partial integration.

  When desktop help is partially integrated, it is available from the top level of the Help Manager. However, you cannot access the help volume from the application's windows. You can also provide an action to access the help from the application group. The following example action displays the help volume located in the help master file MyApp.sdl:

  ACTION OpenMyAppHelp
  {
       LABEL           MyAppHelp
       ARG_COUNT       0
       TYPE            COMMAND
       WINDOW_TYPE     NO_STDIO
       EXEC_STRING     /usr/dt/bin/dthelpview -helpVolume MyApp
       DESCRIPTION     Displays help for the MyApp application.
  }