    | DocBook: The Definitive Guide 2.0.17 (Alpha) |
| | DocBook: The Definitive Guide 2.0.17 (Alpha) |
$Revision: 1666 $
$Date: 2002-06-12 07:19:37 -0400 (Wed, 12 Jun 2002) $
keycap — The text printed on a key on a keyboard
keycap ::=
(%cptr.char.mix;)*Name | Type | Default | |||||||||||||||||||||||
| function |
| None | |||||||||||||||||||||||
| moreinfo |
| "none" | |||||||||||||||||||||||
| otherfunction | CDATA | None |
The following parameter entities contain keycap:
| Parameter Entities | ||
%cptr.char.mix; | %ndxterm.char.mix; | %para.char.mix; |
%refinline.char.mix; | %refname.char.mix; | %tbl.entry.mdl; |
%tech.char.class; | %title.char.mix; | |
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.
Formatted inline. The MoreInfo attribute
can help generate a link or query to retrieve additional information.
In DocBook V4.0, the content model of KeyCap will be
constrained to (#PCDATA | Replaceable |
InlineGraphic).
These elements contain keycap:
action, application, attribution, bibliomisc, bridgehead, citation, citetitle, classsynopsisinfo, code, command, computeroutput, database, emphasis, entry, filename, firstterm, foreignphrase, funcparams, funcsynopsisinfo, function, glosssee, glossseealso, glossterm, hardware, interfacename, keycap, keycombo, lineannotation, link, literal, literallayout, lotentry, member, msgaud, olink, option, optional, para, parameter, phrase, primary, primaryie, productname, programlisting, property, quote, refdescriptor, refentrytitle, refname, refpurpose, remark, screen, screeninfo, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, shortcut, simpara, subtitle, synopsis, systemitem, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocback, tocentry, tocfront, trademark, ulink, userinput.
The following elements occur in keycap:
action, anchor, application, beginpage, classname, code, command, computeroutput, constant, database, email, envar, errorcode, errorname, errortext, errortype, exceptionname, filename, function, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, indexterm, inlinegraphic, inlinemediaobject, interface, interfacename, keycap, keycode, keycombo, keysym, link, literal, markup, medialabel, menuchoice, methodname, mousebutton, nonterminal, olink, ooclass, ooexception, oointerface, option, optional, package, parameter, prompt, property, remark, replaceable, returnvalue, sgmltag, structfield, structname, subscript, superscript, symbol, systemitem, token, type, ulink, uri, userinput, varname.
accel, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, keycode, keycombo, keysym, menuchoice, mousebutton, shortcut.
<!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.
| | | |
| jobtitle | | keycode |