Reference. Reference for the DocBook DTD

[Prev] [Next]


Shortcut

Name

Shortcut---Key combination associated with a software action

Synopsis

Content Model
  (KeyCap | KeyCombo | KeySym | MouseButton)+

Attributes

This element has common and Role attributes.

Name Value(s) Type Default Value
Action (Click |Double-Click |Press |Seq |Simul |Other) #IMPLIED  
MoreInfo (RefEntry|None)   None
OtherAction CDATA #IMPLIED  

Tag Minimization

Both the start- and end-tags are required for this element.

Description

Key combination associated with a software action, typically duplicating a menu choice. Note that a key combination shortcut is different from an accelerator in that the key combination can be a random set of key presses and button clicks, but an accelerator has a direct correlation with the succession of menu choices. For example, ``Ctrl-S'' is a shortcut in many windowing systems for the ``save'' function activated by the File->Save choices in the graphical user interface, but ``Alt-F Alt-S'' is an accelerator that literally invokes the File menu and Save menu item in turn. It has common, Action, OtherAction, and MoreInfo attributes.

Parents

Shortcut occurs in MenuChoice.

Children

Shortcut contains these elements: KeyCap, KeyCombo, KeySym, and MouseButton.

Attributes

Action

Action indicates the type of key combination. The default is unspecified if there is only one child element, Simul if there is more than one. If the value given is Other, the value of the OtherAction attribute should be used.

OtherAction

OtherAction indicates a user-defined key combination type

MoreInfo

Indicates whether the element's content has an associated RefEntry.

Examples

<SCREEN>
<KEYCOMBO><KEYCAP>Alt</KEYCAP><KEYCAP>Enter</KEYCAP></KEYCOMBO>
<INTERFACE>Backup Type:</INTERFACE> <!--random text in Backup window-->
<INTERFACE>Backup T<ACCEL>y</ACCEL>pe:</INTERFACE>
<MOUSEBUTTON>M1</MOUSEBUTTON> <!--conventional names for unlabeled buttons-->
<MOUSEBUTTON>MB1</MOUSEBUTTON>
<MOUSEBUTTON>Left</MOUSEBUTTON>
<GUIICON><INLINEGRAPHIC ENTITYREF="mimeface"></INLINEGRAPHIC>
</GUIICON> <!--in mail program-->
<GUILABEL>File Manager</GUILABEL> <!--window title bar text-->
<GUIMENU>Tools</GUIMENU>
<GUIMENU>Too<ACCEL>l</ACCEL>s</GUIMENU>
<GUIMENUITEM>Save As...</GUIMENUITEM>
<GUIMENUITEM>Save <ACCEL>A</ACCEL>s...</GUIMENUITEM>
<GUISUBMENU>Davenport</GUISUBMENU> <!--folders and mailboxes in mail program-->
<MENUCHOICE>
<GUIMENU>Mailbox</GUIMENU>
<GUISUBMENU>Davenport</GUISUBMENU>
<GUIMENUITEM>New...</GUIMENUITEM>
</MENUCHOICE>
<!--menu item is shown like this:   "Expand _A_ll      Ctrl+*"      -->
<MENUCHOICE>
<SHORTCUT><KEYCAP>Ctrl</KEYCAP><KEYCAP>*</KEYCAP></SHORTCUT>
<GUIMENU>Tree</GUIMENU>  <!--or <ACCEL>T</ACCEL>ree-->
<GUIMENUitem>Expand All</GUIMENUitem> <!--or Expand <ACCEL>A</ACCEL>ll-->
</MENUCHOICE>
<GUIBUTTON>OK</GUIBUTTON>
<GUIBUTTON><ACCEL>O</ACCEL>K</GUIBUTTON>
</SCREEN>


[Prev] ShortAffil
[Next] Sidebar
[Reference Home] [Davenport Group Home]