keycap

keycap — The text printed on a key on a keyboard

Synopsis

Content Model

keycap ::=

Zero or more of:
- 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

Attributes

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

FIXME:

Enumerated values:
“other”	FIXME:

otherfunction

FIXME:

Parents

These elements contain keycap: bridgehead, 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.

Children

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.

Examples

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

ChangeLog

This alpha reference page is $Revision: 1.4 $ published $Date: 2005/10/31 12:31:55 $.


jobtitle		keycode

keycap

Synopsis

Content Model

Attributes

Description

Processing expectations

Attributes

Parents

Children

See Also

Examples

ChangeLog