DocBook: The Definitive Guide By Norman Walsh & Leonard Muellner 1st Edition October 1999 1-56592-580-7, Order Number: 5807 652 pages, $36.95 , Includes CD-ROM

DocBook: The Definitive Guide
Prev		Next

---

ToC

Name

ToC -- A table of contents

Synopsis

Content Model

ToC ::=
((DocInfo?,Title,Subtitle?,TitleAbbrev?)?,
 ToCfront*,
 (ToCpart|ToCchap)*,
 ToCback*)

Attributes

Common attributes

Name	Type	Default
Pagenum	CDATA	None

Tag Minimization

The start-tag is required for this element. The end-tag is optional, if your SGML declaration allows minimization.

Parameter Entities

%nav.class;

%partcontent.mix;

Description

The ToC element defines a table of contents in a document.

The general structure of elements in a ToC is analogous to the structure of the document described. For example, a ToC for a Book might contain TocFront elements for the front-matter of the book, TocChap elements for the body of the book, and TocBack elements for the back matter. Inside each of these are additional elements reflecting the structure of each component.

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.

Parents

These elements contain ToC: Article, Book, Part, Sect1, Sect2, Sect3, Sect4, Sect5, Section, Set.

Children

The following elements occur in ToC: DocInfo, Subtitle, Title, TitleAbbrev, ToCback, ToCchap, ToCfront, ToCpart.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

Attributes

Pagenum

PageNum indicates the page on which this Table of Contents appears in the printed document

Examples

<!DOCTYPE toc PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<toc>
<tocfront pagenum="i">Preface</tocfront>
<tocpart>
  <tocchap>
    <tocentry pagenum="1">Getting Started with SGML/XML</tocentry>
    <toclevel1>
      <tocentry pagenum="1">HTML and SGML vs. XML</tocentry>
    </toclevel1>
    <toclevel1>
      <tocentry pagenum="3">How Does DocBook Fit In?</tocentry>
      <toclevel2>
        <tocentry pagenum="3">A Short DocBook History</tocentry>
      </toclevel2>
    </toclevel1>
    <!-- ... -->
  </tocchap>
</tocpart>
<!-- ... -->
<tocback pagenum="305">Bibliography</tocback>
</toc>

---

Prev	Home	Next
TitleAbbrev	Up	ToCback

Back to: DocBook: The Definitive Guide