DocBook: The Definitive GuideBy Norman Walsh & Leonard Muellner1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM |
RefPurpose
Synopsis
Mixed Content Model
RefPurpose ::= ((#PCDATA|FootnoteRef|XRef|Abbrev|Acronym|Citation|CiteRefEntry| CiteTitle|Emphasis|FirstTerm|ForeignPhrase|GlossTerm|Footnote| Phrase|Quote|Trademark|WordAsWord|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|Author|AuthorInitials| CorpAuthor|ModeSpec|OtherCredit|ProductName|ProductNumber| RevHistory|Comment|Subscript|Superscript|IndexTerm)+)Attributes
Tag Minimization
The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.
Description
The RefPurpose is a concise summary of the topic of the reference page. A RefPurpose is usually limited to a single, short sentence.
Processing expectations
Formatted inline. See RefNameDiv.
In a large Reference, RefNames and RefPurposes are sometimes used to construct a permuted index. A permuted index is a keyword-in-context concordance of lines, like the short definitions in this element reference; the keyword cycles alphabetically through the words of the (definition) lines.
Formatting reference pages may require a fairly sophisticated processing system. Much of the meta-information about a reference page (its name, type, purpose, title, and classification) is stored in wrappers near the beginning of the RefEntry.
Common presentational features, such as titles and running headers, may require data from several of these wrappers plus some generated text. Other formatting often requires that these elements be reordered.
Future Changes
The InterfaceDefinition element will be discarded in DocBook V4.0. It will no longer be available in the content model of this element.
Children
The following elements occur in RefPurpose: Abbrev, Acronym, Action, Anchor, Application, Author, AuthorInitials, Citation, CiteRefEntry, CiteTitle, ClassName, Command, Comment, ComputerOutput, Constant, CorpAuthor, Database, Email, Emphasis, EnVar, ErrorCode, ErrorName, ErrorType, Filename, FirstTerm, Footnote, FootnoteRef, ForeignPhrase, Function, GlossTerm, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware, IndexTerm, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, Link, Literal, Markup, MediaLabel, MenuChoice, ModeSpec, MouseButton, MsgText, OLink, Option, Optional, OtherCredit, Parameter, Phrase, ProductName, ProductNumber, Prompt, Property, Quote, Replaceable, ReturnValue, RevHistory, SGMLTag, StructField, StructName, Subscript, Superscript, Symbol, SystemItem, Token, Trademark, Type, ULink, UserInput, VarName, WordAsWord, XRef.
In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.
Back to: DocBook: The Definitive Guide
© 2001, O'Reilly & Associates, Inc.