[Contents]
[Index]
[Next]
[Previous]
Help Menu
Description
There are two acceptable models for the contents of the
Help Menu. The OSF/Motif Style Guide allows
either model.
The common Menu contents for this model are described in the
following text. Note that you should only include those functions
actually supported by your application. The Help Menu
can contain a TearOffButton. The
illustration on this reference page shows this first model of a
Help Menu.
- On Context Shift+Help
- Must initiate context-sensitive help by changing the shape of
the pointer to the question pointer described in Pointer Shapes.
When the user moves the pointer to the component help is wanted on and
presses BSelect,
any available context-sensitive help for the component must be
presented, and the pointer reverts from the question pointer. This
action must have the mnemonic C. If the action uses
an accelerator, it should be
.
- On Help
- Must provide information on how to use the application's help
facility. This action must have the mnemonic H.
- On Window
- Must provide general information about the window from which
help was requested. This action must have the mnemonic
W.
- On Keys
- Must provide information about the application's use of
function keys, mnemonics, and keyboard accelerators. This action must
have the mnemonic K.
- Index
- Must provide an index for all help information in the
application. This action must have the mnemonic I.
The index can provide search capabilities.
- Tutorial
- Must provide access to the application's tutorial. This action
must have the mnemonic T.
- On Version
- Must provide the name and version of the application. This
action must have the mnemonic V. It can provide
other information as well.
The common Menu contents in the second model are described in the
following text. Note that you should only include those functions
actually supported by your application. The Help Menu
can contain a TearOffButton.
- Context-Sensitive Help Shift+Help
- Must initiate context-sensitive help by changing the shape of
the pointer to the question pointer described in Pointer Shapes.
When the user moves the pointer to the component help is wanted on and
presses BSelect,
any available context-sensitive help for the component must be
presented, and the pointer reverts from the question pointer. This
action should be followed by a separator. This action must have the
mnemonic C. If the action uses an accelerator, it
should be
.
- Overview
- Must provide general information about the application window
from which help was requested. This action must have the mnemonic
O.
- Index
- Must provide an index for all help information in the
application. This action must have the mnemonic I.
The index can provide search capabilities.
- Keyboard
- Must provide information about the application's use of
function keys, mnemonics, and keyboard accelerators. This action must
have the mnemonic K.
- Tutorial
- Must provide access to the application's tutorial. This action
must have the mnemonic T.
- Using Help
- Must provide information on how to use the application's help
facility. This action must have the mnemonic H.
- Product Information
- Must provide the name and version of the application. This
action must have the mnemonic P. It can provide
other information as well.
Applications should place additional Help Menu
items between Index and Using Help.
Help is usually provided in DialogBoxes but can also appear in the
message area. You should include Menu items in the order
described. If you add new Menu items, you should insert them near
similar elements.
Illustration
Related Information
See Application Design
Principles for more information on the MenuBar system and for
general information about Menu design.