Siebel Advisor API Reference > Utility Functions for Siebel Advisor >
Use the ShowHelp function to open a separate window displaying the information contained in the \ui\helpset.htm file. The helpset contains information about the application user interface and the controls that it contains, and you can edit the generic information to customize the help for your own application.
- The information that appears when the ShowHelp function is called must be located in the file helpset.htm, and this file must be located in the application ui subdirectory.
- The configuration variable APP_HELP_WIN_ARGS in the Application Configuration file (\custom\app_config.js) defines the attributes of the Help window, including size, whether a status bar, menu bar, and scroll bars appear, and whether the window is resizable.
- The helpset.htm file generated when you create a new project in Advisor contains a frameset that refers to the following source files: help_top.htm, help_mnu.htm, help_ovr.htm, and help_nav.htm. Using a frameset is optional. All of the Help information can appear in the helpset.htm file only.
The following sample code creates a link to the Help window using a link surrounding a button image called btn_hlp.gif.