keycap

$Revision: 1.3 $

$Date: 2002/06/12 11:18:15 $

keycap — The text printed on a key on a keyboard

Synopsis

Mixed Content Model

keycap ::=
(#PCDATA|link|olink|ulink|action|application|classname|methodname|
 interfacename|exceptionname|ooclass|oointerface|ooexception|
 command|computeroutput|database|email|envar|errorcode|errorname|
 errortype|errortext|filename|function|guibutton|guiicon|guilabel|
 guimenu|guimenuitem|guisubmenu|hardware|interface|keycap|keycode|
 keycombo|keysym|literal|code|constant|markup|medialabel|
 menuchoice|mousebutton|option|optional|parameter|prompt|property|
 replaceable|returnvalue|sgmltag|structfield|structname|symbol|
 systemitem|uri|token|type|userinput|varname|nonterminal|anchor|
 remark|subscript|superscript|inlinegraphic|inlinemediaobject|
 indexterm|beginpage)*

Attributes

Common attributes

Name

Type

Default

function
Enumeration:
alt
backspace
command
control
delete
down
end
enter
escape
home
insert
left
meta
option
other
pagedown
pageup
right
shift
space
tab
up
None
moreinfo
Enumeration:
none
refentry
"none"
otherfunctionCDATANone

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. The MoreInfo attribute can help generate a link or query to retrieve additional information.

Future Changes

In DocBook V4.0, the content model of KeyCap will be constrained to (#PCDATA | Replaceable | InlineGraphic).

Attributes

moreinfo

If MoreInfo is set to RefEntry, it implies that a RefEntry exists which further describes the Keycap.

See Also

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

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<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>

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.

For additional examples, see also keycode, keycombo, keysym.