    | DocBook: The Definitive Guide 2.0.9 (Alpha) |
| | DocBook: The Definitive Guide 2.0.9 (Alpha) |
$Revision: 1.3 $
$Date: 2002/06/12 11:18:31 $
refentrytitle — The title of a reference page
refentrytitle ::= (#PCDATA|footnoteref|xref|abbrev|acronym|citation|citerefentry| citetitle|emphasis|firstterm|foreignphrase|glossterm|footnote| phrase|orgname|quote|trademark|wordasword|personname|link|olink| ulink|action|application|classname|methodname|interfacename| exceptionname|ooclass|oointerface|ooexception|command| computeroutput|database|email|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|inlinegraphic|inlinemediaobject|inlineequation| synopsis|cmdsynopsis|funcsynopsis|classsynopsis|fieldsynopsis| constructorsynopsis|destructorsynopsis|methodsynopsis|indexterm| beginpage)*
Common attributes and common linking attributes.
A RefEntryTitle is the title of a reference page. It is frequently the same as the first RefName or the RefDescriptor, although it may also be a longer, more general title.
Formatted as a displayed block.
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 heads, 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 refentrytitle: abbrev, acronym, action, anchor, application, author, authorinitials, beginpage, citation, citerefentry, citetitle, classname, classsynopsis, cmdsynopsis, code, command, computeroutput, constant, constructorsynopsis, corpauthor, corpcredit, database, destructorsynopsis, email, emphasis, envar, errorcode, errorname, errortext, errortype, exceptionname, fieldsynopsis, filename, firstterm, footnote, footnoteref, foreignphrase, funcsynopsis, function, glossterm, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, indexterm, inlineequation, inlinegraphic, inlinemediaobject, interface, interfacename, keycap, keycode, keycombo, keysym, link, literal, markup, medialabel, menuchoice, methodname, methodsynopsis, modespec, mousebutton, nonterminal, olink, ooclass, ooexception, oointerface, option, optional, orgname, othercredit, parameter, personname, phrase, productname, productnumber, prompt, property, quote, remark, replaceable, returnvalue, revhistory, sgmltag, structfield, structname, subscript, superscript, symbol, synopsis, systemitem, token, trademark, type, ulink, uri, userinput, varname, wordasword, xref.
| | | |
| refentryinfo | | reference |