    |
DocBook: The Definitive Guide 2.0.17 (Alpha) |
| |
DocBook: The Definitive Guide 2.0.17 (Alpha) |
$Revision$
$Date$
refpurpose — A short (one sentence) synopsis of the topic of a reference page
refpurpose ::= (#PCDATA|footnoteref|xref|biblioref|abbrev|acronym|citation|citerefentry|citetitle|citebiblioid|emphasis|firstterm|foreignphrase|glossterm|termdef|footnote|phrase|orgname|quote|trademark|wordasword|personname|link|olink|ulink|action|application|classname|methodname|interfacename|exceptionname|ooclass|oointerface|ooexception|package|command|computeroutput|database|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|author|authorinitials|corpauthor|corpcredit|modespec|othercredit|productname|productnumber|revhistory|remark|subscript|superscript|indexterm|beginpage)*
The RefPurpose is a concise summary of the topic of the
reference page. A RefPurpose is usually limited to a single,
short sentence.
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.
The InterfaceDefinition
element will be discarded in DocBook V4.0. It will no longer be available
in the content model of this element.
The following elements occur in refpurpose:
abbrev, acronym, action, anchor, application, author, authorinitials, beginpage, biblioref, citation, citebiblioid, citerefentry, citetitle, classname, code, command, computeroutput, constant, corpauthor, corpcredit, database, email, emphasis, envar, errorcode, errorname, errortext, errortype, exceptionname, filename, firstterm, footnote, footnoteref, foreignphrase, function, glossterm, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, indexterm, interface, interfacename, keycap, keycode, keycombo, keysym, link, literal, markup, medialabel, menuchoice, methodname, modespec, mousebutton, nonterminal, olink, ooclass, ooexception, oointerface, option, optional, orgname, othercredit, package, parameter, personname, phrase, productname, productnumber, prompt, property, quote, remark, replaceable, returnvalue, revhistory, sgmltag, structfield, structname, subscript, superscript, symbol, systemitem, termdef, token, trademark, type, ulink, uri, userinput, varname, wordasword, xref.
|
|
|
|
| refnamediv | |
refsect1 |