Skip to main content
Version: DocBook V4.5

tocentry

tocentry — A component title in a table of contents

Synopsis

Mixed Content Model

tocentry ::=
(#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

Name

Type

Default

pagenum

CDATA

None

linkend

IDREF

None

Description

A ToCentry contains the title of an entry in a ToC. In entries that allow nested structure, such as ToCchap, this additional wrapper is necessary in order to require that a title be present.

Processing expectations

Formatted as a displayed block.

In real life, ToCs are usually generated automatically by the presentation system and never have to be represented explicitly in the document source.

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 tocentry: tocchap, toclevel1, toclevel2, toclevel3, toclevel4, toclevel5, tocpart.

Attributes

linkend

Linkend points to the associated element in the document.

pagenum

PageNum indicates the page on which this ToC element appears in some version of the printed document.

Examples

For examples, see toc.