DocBook 5: The Definitive Guide
| | By Norman Walsh & Leonard Muellner 1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM
|
| DocBook: The Definitive Guide | ||
|---|---|---|
| Prev | Next | |
Name
Shortcut -- A key combination for an action that is also accessible through a menu
Synopsis
Content Model
Shortcut ::= ((KeyCap|KeyCombo|KeySym|MouseButton)+)
Attributes
Common attributes
Name | Type | Default |
| OtherAction | CDATA | None |
| Action | Enumeration: ClickDouble-ClickOtherPressSeqSimul | None |
| MoreInfo | Enumeration: NoneRefEntry | "None" |
Tag Minimization
Both the start- and end-tags are required for this element.
Description
A Shortcut contains the key combination that is a shortcut for a MenuChoice. Users that are familiar with the shortcuts can access the functionality of the corresponding menu choice, without navigating through the menu structure to find the right menu item.
Processing expectations
Formatted inline. The MoreInfo attribute can help generate a link or query to retrieve additional information.
Parents
These elements contain Shortcut: MenuChoice.
Children
The following elements occur in Shortcut: KeyCap, KeyCombo, KeySym, MouseButton.
In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.
Attributes
- Action
Action identifies the nature of the action taken. If Shortcut contains more than one action element, Simul is default value for Action, otherwise there is no default.
If Other is specified, OtherAction should be used to identify the nature of the action.
- MoreInfo
If MoreInfo is set to RefEntry, it implies that a RefEntry exists which further describes the Shortcut.
- OtherAction
OtherAction should be used when Action is set to Other. It identifes the nature of the action in some application-specific way.
See Also
Accel, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, KeyCap, KeyCode, KeyCombo, KeySym, MenuChoice, MouseButton
Examples
<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <para> You can exit from GNU Emacs with <menuchoice> <shortcut> <keycombo><keysym>C-x</keysym><keysym>C-c</keysym></keycombo> </shortcut> <guimenu>Files</guimenu> <guimenuitem>Exit Emacs</guimenuitem> </menuchoice>. </para>
You can exit from GNU Emacs with Files->Exit Emacs (C-x-C-c).
For additional examples, see also MenuChoice.
| Prev | Home | Next |
| ShortAffil | Up | Sidebar |
Back to: DocBook: The Definitive Guide
O'Reilly Home | O'Reilly Bookstores | How to Order | O'Reilly Contacts International | About O'Reilly | Affiliated Companies
© 1999, O'Reilly & Associates, Inc.