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 |
ToCentry
Synopsis
Mixed Content Model
ToCentry ::= ((#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|InlineGraphic| InlineMediaObject|InlineEquation|Synopsis|CmdSynopsis| FuncSynopsis|IndexTerm)+)Attributes
Name
Type
Default
Linkend IDREF None Pagenum CDATA None Tag Minimization
Both the start- and end-tags are required for this element.
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.
Children
The following elements occur in ToCentry: Abbrev, Acronym, Action, Anchor, Application, Author, AuthorInitials, Citation, CiteRefEntry, CiteTitle, ClassName, CmdSynopsis, Command, Comment, ComputerOutput, Constant, CorpAuthor, Database, Email, Emphasis, EnVar, ErrorCode, ErrorName, ErrorType, Filename, FirstTerm, Footnote, FootnoteRef, ForeignPhrase, FuncSynopsis, Function, GlossTerm, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware, IndexTerm, InlineEquation, InlineGraphic, InlineMediaObject, 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, Synopsis, SystemItem, Token, Trademark, Type, ULink, UserInput, VarName, WordAsWord, XRef.
In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.
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.
Back to: DocBook: The Definitive Guide
© 2001, O'Reilly & Associates, Inc.