DocBook 5: The Definitive Guide

Name

KeyCap -- The text printed on a key on a keyboard

Synopsis

Mixed Content Model

KeyCap ::= ((#PCDATA|Link|OLink|ULink|Action|Application|ClassName|Command| ComputerOutput|Database|Email|EnVar|ErrorCode|ErrorName| ErrorType|Filename|Function|GUIButton|GUIIcon|GUILabel|GUIMenu| GUIMenuItem|GUISubmenu|Hardware|Interface|InterfaceDefinition| KeyCap|KeyCode|KeyCombo|KeySym|Literal|Constant|Markup| MediaLabel|MenuChoice|MouseButton|MsgText|Option|Optional| Parameter|Prompt|Property|Replaceable|ReturnValue|SGMLTag| StructField|StructName|Symbol|SystemItem|Token|Type|UserInput| VarName|Anchor|Comment|Subscript|Superscript|InlineGraphic| InlineMediaObject|IndexTerm)+)

Attributes

Common attributes

Tag Minimization

Both the start- and end-tags are required for this element.

Parameter Entities

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

Parents

These elements contain KeyCap: Action, Application, Attribution, BiblioMisc, BridgeHead, Citation, CiteTitle, Command, Comment, ComputerOutput, Database, Emphasis, entry, Filename, ForeignPhrase, FuncParams, FuncSynopsisInfo, Function, GlossSee, GlossSeeAlso, GlossTerm, Hardware, Interface, InterfaceDefinition, 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, Screen, ScreenInfo, Secondary, SecondaryIE, See, SeeAlso, SeeAlsoIE, SeeIE, Seg, SegTitle, Shortcut, SimPara, Subtitle, Synopsis, SystemItem, Term, Tertiary, TertiaryIE, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, Trademark, ULink, UserInput.

Children

The following elements occur in KeyCap: Action, Anchor, Application, ClassName, Command, Comment, ComputerOutput, Constant, Database, Email, EnVar, ErrorCode, ErrorName, ErrorType, Filename, Function, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware, IndexTerm, InlineGraphic, InlineMediaObject, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, Link, Literal, Markup, MediaLabel, MenuChoice, MouseButton, MsgText, OLink, Option, Optional, Parameter, Prompt, Property, Replaceable, ReturnValue, SGMLTag, StructField, StructName, Subscript, Superscript, Symbol, SystemItem, Token, Type, ULink, UserInput, VarName.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

In some contexts, the following elements are excluded: IndexTerm.

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 V3.1//EN"> <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 >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.

Back to: DocBook: The Definitive Guide