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

keycombo

keycombo — A combination of input actions.

Synopsis

keycombo ::=

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

For actions that require multiple keystrokes, mouse actions, or other physical input selections, the keycombo element provides a wrapper for the entire set of events.

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 keycombo: keycap, keycombo, keysym, mousebutton.

Examples

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

<para>To move a highlighted region, use 
<keycombo action='simul'>
  <keycap>Shift</keycap>
  <mousebutton>Button1</mousebutton>
</keycombo>
and drag the text to the new location.
</para>

</article>

To move a highlighted region, use Shift+Button1 and drag the text to the new location.