DocBook 5.1: The Definitive Guide  (Version 1.5.3 for DocBook 5.1)

shortcut

shortcut — A key combination for an action that is also accessible through a menu.

Synopsis

shortcut ::=

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • Exactly one of:
    • action (enumeration)
      • “click”
      • “double-click”
      • “press”
      • “seq”
      • “simul”
    • Each of:
      • action (enumeration)
        • “other”
      • otheraction

Required attributes are shown in bold.

Description

A shortcut contains the key combination that is a shortcut for a menuchoice. Users who 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.

Attributes

Common attributes and common linking attributes.

action

Identifies the nature of the action taken. If keycombo contains more than one element, simul is the default, otherwise there is no default.

Enumerated values:
“click”

A (single) mouse click.

“double-click”

A double mouse click.

“press”

A mouse or key press.

“seq”

Sequential clicks or presses.

“simul”

Simultaneous clicks or presses.

otheraction

Identifies the non-standard action in some unspecified way.

Children

The following elements occur in shortcut: keycap, keycombo, keysym, mousebutton.

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example shortcut</title>

<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>

</article>

You can exit from GNU Emacs with

<menuchoice>C-x-C-cFilesExit Emacs</menuchoice>
.