keycap — The text printed on a key on a keyboard.


keycap ::=


Common attributes and common linking attributes.

Additional attributes:

  • Exactly one of:
    • function (enumeration)
      • “alt”
      • “altgr”
      • “backspace”
      • “command”
      • “control”
      • “delete”
      • “down”
      • “end”
      • “enter”
      • “escape”
      • “home”
      • “insert”
      • “left”
      • “meta”
      • “option”
      • “pagedown”
      • “pageup”
      • “right”
      • “return”
      • “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.

Processing expectations

Formatted inline.


Common attributes and common linking attributes.

any attribute

Any attribute in any other explicit namespace


Identifies the function key

Enumerated values:

The "Alt" key


The "Alt Graph" key


The "Backspace" key


The "Command" key


The "Control" key


The "Delete" key


The down arrow


The "End" key


The "Enter" key


The "Escape" key


The "Home" key


The "Insert" key


The left arrow


The "Meta" key


The "Option" key


The page down key


The page up key


The right arrow


The "Return" key


The "Shift" key


The spacebar


The "Tab" key


The up arrow


Specifies a keyword that identifies the non-standard key


These elements contain keycap: bridgehead, caption (db.html.caption), citation, citetitle, classsynopsisinfo, contrib, emphasis (db.emphasis), entry, enumitemdescription, firstterm (db.firstterm), funcsynopsisinfo, glosssee, glossseealso, glossterm (db.glossterm), keycombo, 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, shortcut, simpara, subtitle, synopsis, synopsisinfo, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocentry, userinput.


The following elements occur in keycap: 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.

See Also

Related elements: accel, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, keycode, keycombo, keysym, menuchoice, mousebutton, shortcut.


 1 |<article xmlns=''>
   |<title>Example keycap</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>.
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.