Previous Topic: Maintaining Help

Next Topic: Printing Help Files


Help Definitions

When a user presses F1 (Help), one or several panels are displayed that contain help information. The help that is displayed is dependent on where the user pressed F1 (Help). For example, if the user requests help while the cursor is located in an input field then the help associated with that field is displayed.

Note: Not all fields are supported by the CAS Help facility.

Help text can be structured in panel format, in scrollable text format, or using a combination of both. Facilities for constructing menus, help indexes and tutorials within the help file are also available. Help files can be merged or copied, both during maintenance and while being displayed.

A text editor is available to define and maintain help text. Optional embedding of control codes is provided to make control of text color, highlight, intensity and formatting as easy as possible. Facilities for browsing (which displays the help file) and viewing (which displays the help as the user sees it) are available.

Help files can be added and maintained at either application level, function level, window level, or field level.