Whole document tree


www.fifi.org
    Documentation
        Manpages
        GNU Info
        Debian document tree
        Whole document tree
    Trigance web page
    Public services
    User info
    Mailing lists
    Secure server
    Multilingual usage
 

Copyright (C) 2000-2012
Philippe Troin
<webmaster@fifi.org>.

Validate HTML
Validate CSS

    

Whole document tree

ToC
Guide to the DocBook DTD
PrevNext

ToC

Name

ToC -- Table of contents

Content Model

  (DocInfo?, Title, TitleAbbrev?)?,
  ToCfront*,
  (ToCpart | ToCchap)*,
  ToCback*

Attributes

This element has common and Role attributes.

NameValue(s)TypeDefault Value
PagenumCDATA#IMPLIED 

Tag Minimization

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

Description

ToC is a table of contents, which may be a book component on its own or may occur before or after the main content of a Sect, or after the main content of an Article. It may have a DocInfo, Title, and TitleAbbrev. ToC is subdivided to follow the divisions of a book: following the optional Title and TitleAbbrev, a ToC may have any number of ToCfronts, which are the entries for the front matter. Following the ToCfronts, if any, ToC may have any number of ToCparts (entries for Parts) or ToCchaps (entries for Chapters and Appendices), followed by any number of ToCbacks (entries for back matter). A ToCpart must begin with one or more ToCEntries, then contains any number of ToCchaps. A ToCchap must begin with one or more ToCEntries, then may have any number of ToClevel1s, which are entries for Sect1s. ToClevel1s must begin with one or more ToCEntries, then may have any number of ToClevel2s, and so on down to ToClevel5, which may have only ToCEntries. Thus if you have a Table of Contents that shows section headings, the second-level entries are nested within the first-level entries, and so on. ToC has PageNum and common attributes.

Parents

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

Children

ToC contains these elements: DocInfo, Title, TitleAbbrev, ToCback, ToCchap, ToCfront, ToCpart.

In some contexts, additional elements may be allowed by inclusions in parent elements.

Attributes

Pagenum

PageNum is the number of the page on which a given element begins or occurs in a printed book.

Examples

<TOC><!-- table of contents for a book titled Big Countries of 
          the Western Hemisphere and A Few of Their Parts -->
<TITLE>Table of Contents</TITLE>

<TOCFRONT PAGENUM="viii">Preface</TOCFRONT>

<TOCPART>
<TOCENTRY>North America</TOCENTRY>
<TOCCHAP LABEL="1">
<TOCENTRY>Canada</TOCENTRY>
<TOCLEVEL1>
<TOCENTRY>Ontario</TOCENTRY>
<TOCENTRY>British Columbia</TOCENTRY>
</TOCLEVEL1>
</TOCCHAP>
<TOCCHAP LABEL="2">
<TOCENTRY>United States</TOCENTRY>
<TOCLEVEL1>
<TOCENTRY>California</TOCENTRY>
<TOCLEVEL2>
<TOCENTRY>Napa County</TOCENTRY>
</TOCLEVEL2>
<TOCLEVEL2>
<TOCENTRY>Sonoma County</TOCENTRY>
<TOCLEVEL3>
<TOCENTRY>Southern Sonoma County</TOCENTRY>
<TOCLEVEL4>
<TOCENTRY>Sebastopol</TOCENTRY>
<TOCLEVEL5>
<TOCENTRY>Morris Street</TOCENTRY>
</TOCLEVEL5>
</TOCLEVEL4>
</TOCLEVEL3>
</TOCLEVEL2>
</TOCLEVEL1>
<TOCLEVEL1>
<TOCENTRY>Nevada</TOCENTRY>
</TOCLEVEL1>
<TOCLEVEL1>
<TOCENTRY>Arizona</TOCENTRY>
</TOCLEVEL1>
</TOCCHAP>
</TOCPART>

<TOCPART>
<TOCENTRY>South America</TOCENTRY>
<TOCCHAP LABEL="1">
<TOCENTRY>Brazil</TOCENTRY>
</TOCCHAP>
<TOCCHAP LABEL="2">
<TOCENTRY>Argentina</TOCENTRY>
</TOCCHAP>
</TOCPART>

<TOCBACK PAGENUM="167">Glossary</TOCBACK>
<TOCBACK PAGENUM="177">Gazetteer</TOCBACK>
</TOC>
PrevHomeNext
TitleAbbrevUpToCback