keycap — The text printed on a key on a keyboard
keycap ::=
(text | phrase
db._phrase | replaceable
| Graphic inlines | Indexing inlines | Linking inlines | Ubiquitous inlines)*
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.
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.
Common attributes and common linking attributes.
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 |
Identifies the function key
Enumerated values: | |
---|---|
“other” | Indicates a nonstandard function key |
Specifies a keyword that identifies the nonstandard key
accel
, guibutton
, guiicon
, guilabel
, guimenu
, guimenuitem
, guisubmenu
, keycode
, keycombo
, keysym
, menuchoice
, mousebutton
, shortcut
<article xmlns='http://docbook.org/ns/docbook'> <title>Example keycap</title> <para>The <keycap>F1</keycap> key on an IBM PC keyboard generates the scan code <keycode>0x3B</keycode> when pressed. This value is defined as <keysym>KEY_F1</keysym> in <filename class="headerfile">keyboard.h</filename>. </para> </article>