Skip to main content
Version: DocBook V4.5

refentrytitle

refentrytitle — The title of a reference page

Synopsis

Mixed Content Model

refentrytitle ::=
(#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|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)*

Attributes

Common attributes

Description

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.

Processing expectations

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.

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.

Parents

These elements contain refentrytitle: citerefentry, refmeta.

Examples

For examples, see citerefentry, manvolnum, refentry.