By Norman Walsh & Leonard Muellner 1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM |
DocBook: The Definitive Guide | ||
---|---|---|
Prev | Next |
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)+)
Common attributes
Name | Type | Default |
MoreInfo | Enumeration: None | "None" |
Both the start- and end-tags are required for this element.
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, 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.
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.
If MoreInfo is set to RefEntry, it implies that a RefEntry exists which further describes the Keycap.
Accel, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, KeyCode, KeyCombo, KeySym, MenuChoice, MouseButton, Shortcut
<!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.
Prev | Home | Next |
JobTitle | Up | KeyCode |
Back to: DocBook: The Definitive Guide
© 1999, O'Reilly & Associates, Inc.