    |
DocBook: The Definitive Guide 0.0.25 for DocBook V5.0 (Alpha) |
| |
DocBook: The Definitive Guide 0.0.25 for DocBook V5.0 (Alpha) |
keycap — The text printed on a key on a keyboard
keycap ::= ![[-]](graphics/down.gif)
![[+]](graphics/right.gif)
phrase (db._phrase)replaceable
altanchorannotationbibliorefindexterm (db.indexterm.endofrange)indexterm (db.indexterm.singular)indexterm (db.indexterm.startofrange)inlinemediaobjectlinkolinkremarksubscriptsuperscriptxrefCommon attributes and common linking attributes.
Additional attributes:
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 "Control" 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 spacebar |
| “tab” |
The "Tab" key |
| “up” |
The up arrow |
Identifies the function key
| Enumerated values: | |
|---|---|
| “other” |
Indicates a non-standard function key |
Specifies a keyword that identifies the non-standard key
These elements contain keycap: bridgehead, caption (db.html.caption), citation, citetitle, classsynopsisinfo, emphasis (db.emphasis), entry, firstterm, funcsynopsisinfo, glosssee, glossseealso, glossterm, html:button, html:label, html:legend, keycombo, link, literallayout, member, olink, orgdiv, para, phrase (db.phrase), primary, primaryie, programlisting, quote, refdescriptor, refentrytitle, refname, refpurpose, screen, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, shortcut, simpara, subtitle, synopsis, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocentry, userinput.
The following elements occur in keycap: text, alt, anchor, annotation, biblioref, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, link, olink, phrase (db._phrase), remark, replaceable, subscript, superscript, xref.
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>
The F1 key on an IBM PC keyboard generates the scan code 0x3B when pressed. This value is defined as KEY_F1 in keyboard.h.
| |
|
|
| jobtitle | |
keycode |