Common Desktop Environment: Style Guide and Certification Checklist

Help Menu Contents


Note -

These requirements apply only in a left-to-right language environment in an English-language locale. You must make the appropriate changes for other locales.


Recommended 

bv: 

If your application includes a Help menu, it contains the following set of choices, with the specified functionality, when the actions are actually supported by your application. The Help choices included here supersede those listed for Motif 1.2. 

This is the Common Desktop Environment-recommended Help menu and should be used instead of the Motif 1.2 Help menu. Items should be presented to the user in the order listed. 

  • Overview [REQUIRED]

    Provides general information about the window from which help was accessed or about the application overall. The mnemonic is v. Place a separator after.

  • Index [OPTIONAL]

    Provides an index listing topics for all help information available for your application. The mnemonic is I.

  • Table of Contents [RECOMMENDED]

    Provides a table of contents listing topics for all help information available for your application. The mnemonic is C.

  • Tasks [RECOMMENDED]

    Provides access to help information indicating how to perform different tasks using your application. The mnemonic is T.

  • Reference [RECOMMENDED]

    Provides access to reference information. The mnemonic is R.

  • Tutorial [OPTIONAL]

    Provides access to your application's tutorial. The mnemonic is l.

  • Keyboard [OPTIONAL]

    Provides information about your application's use of function keys, mnemonics, and keyboard accelerators. Also provides information on general Common Desktop Environment use of such keys. The mnemonic is K.

   

 

 

 

 

 

  • Mouse [OPTIONAL]

    Provides information about using a mouse with your application. The mnemonic is M.

  • Mouse and Keyboard [OPTIONAL]

    Provides information about your application's use of function keys, mnemonics, keyboard accelerators and mouse operations. Also provides information on general Common Desktop Environment use of such keys. The mnemonic is M.

  • On Item [OPTIONAL]

    Initiates context-sensitive help by changing the shape of the pointer to the question mark pointer. When the user moves the pointer to a component and presses BSelect, any available context-sensitive help for the component is presented. The mnemonic is O.

  • Using Help [REQUIRED]

    Provides information on how to use the Common Desktop Environment Help Facility. The mnemonic is U.

  • About applicationname [REQUIRED]

    Displays a dialog box indicating, minimally, the name and version of your application, and displaying its icon or some other signature graphic for your application. The mnemonic is A.

The Overview, Using Help and About items are required. The Table of Contents, Tasks and Reference items are recommended. You can choose to have separate Mouse and Keyboard topics, or have a single combined Mouse and Keyboard topic. You should not use all three items.