DocBook 5: The Definitive Guide

Name

keycap — The text printed on a key on a keyboard

Synopsis

keycap ::= (text | phrase ^db._phrase | replaceable | Graphic inlines | Indexing inlines | Linking inlines | Ubiquitous inlines)*

Attribute synopsis

Common attributes and common linking attributes.

Additional attributes:

• Exactly one of:

  • function (enumeration) = “alt” | “backspace” | “command” | “control” | “delete” | “down” | “end” | “enter” | “escape” | “home” | “insert” | “left” | “meta” | “option” | “pagedown” | “pageup” | “right” | “shift” | “space” | “tab” | “up”

  • Each of:

    • function (enumeration) = “other”

    • otherfunction

Required attributes are shown in bold.

Description

The keycap identifies the text printed on a physical key on a computer keyboard. This is distinct from any scan code that it may generate (keycode), or any symbolic name (keysym) that might exist for the key.

Processing expectations

Formatted inline.

Attributes

Common attributes and common linking attributes.

function

Identifies the function key

Enumerated values:
“alt”	The Alt key
“backspace”	The Backspace key
“command”	The Command key
“control”	The Ctrl key
“delete”	The Delete key
“down”	The down arrow
“end”	The End key
“enter”	The Enter or Return key
“escape”	The Escape key
“home”	The Home key
“insert”	The Insert key
“left”	The left arrow
“meta”	The Meta key
“option”	The Option key
“pagedown”	The page down key
“pageup”	The page up key
“right”	The right arrow
“shift”	The Shift key
“space”	The space bar
“tab”	The Tab key
“up”	The up arrow

function

Identifies the function key

Enumerated values:
“other”	Indicates a ...