keycode

keycode — The internal, frequently numeric, identifier for a key on a keyboard.

Synopsis

keycode ::=

Zero or more of:
- text
- replaceable
- Graphic inlines
  - inlinemediaobject
- Indexing inlines
  - indexterm (db.indexterm.endofrange)
  - indexterm (db.indexterm.singular)
  - indexterm (db.indexterm.startofrange)
- Linking inlines
- Ubiquitous inlines
  - abbrev
  - acronym
  - alt
  - anchor
  - annotation
  - biblioref
  - coref
  - date
  - emphasis (db._emphasis)
  - firstterm (db._firstterm)
  - footnote
  - footnoteref
  - foreignphrase (db._foreignphrase)
  - glossterm (db._glossterm)
  - indexterm (db.indexterm.endofrange)
  - indexterm (db.indexterm.singular)
  - indexterm (db.indexterm.startofrange)
  - inlinemediaobject
  - link
  - olink
  - phrase (db._phrase)
  - quote (db._quote)
  - remark
  - subscript
  - superscript
  - trademark
  - wordasword
  - xref

Attributes

Common linking attributes.

None.

Description

The keycode identifies a numeric value (e.g., scan code) associated with a key on a computer keyboard. This is distinct from any text (keycap) that might be printed on the key or any symbolic name (keysym) that might exist for the key.

Processing expectations

Formatted inline.

Attributes

Common linking attributes.

any attribute: Any attribute in any other explicit namespace

Parents

These elements contain keycode: bridgehead, caption (db.html.caption), citation, citetitle, classsynopsisinfo, contrib, emphasis (db.emphasis), entry, enumitemdescription, firstterm (db.firstterm), funcsynopsisinfo, glosssee, glossseealso, glossterm (db.glossterm), link, literallayout, member, meta (db.meta.content), olink, orgdiv, para, phrase (db.phrase), primary, primaryie, programlisting, quote (db.quote), refdescriptor, refentrytitle, refname, refpurpose, remark, screen, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, simpara, subtitle, synopsis, synopsisinfo, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocentry, userinput.

Children

The following elements occur in keycode: text, abbrev, acronym, alt, anchor, annotation, biblioref, coref, date, emphasis (db._emphasis), firstterm (db._firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), glossterm (db._glossterm), indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, link, olink, phrase (db._phrase), quote (db._quote), remark, replaceable, subscript, superscript, trademark, wordasword, xref.

Examples

 1 |<article xmlns='http://docbook.org/ns/docbook'>
   |<title>Example keycode</title>
   | 
   |<para>The <keycap>F1</keycap> key on an IBM PC keyboard generates the
 5 |scan code <keycode>0x3B</keycode> when pressed.  This value
   |is defined as <keysym>KEY_F1</keysym> in 
   |<filename class="headerfile">keyboard.h</filename>.
   |</para>
   | 
10 |</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.