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

Index
Guide to the DocBook DTD
PrevNext

Index

Name

Index -- Index to content

Content Model

  ((DocInfo?, Title, TitleAbbrev?)?, (CalloutList
  | GlossList | ItemizedList | OrderedList | SegmentedList
  | SimpleList | VariableList | Caution | Important | Note
  | Tip | Warning | LiteralLayout | ProgramListing
  | ProgramListingCO | Screen | ScreenCO | ScreenShot
  | Synopsis | CmdSynopsis | FuncSynopsis | FormalPara | Para
  | SimPara | Address | BlockQuote | Graphic | GraphicCO
  | InformalEquation | InformalExample | InformalTable
  | Equation | Example | Figure | Table | MsgSet | Procedure
  | Sidebar | Anchor | BridgeHead | Comment | Highlights
  | Abstract | AuthorBlurb | Epigraph)*, (IndexDiv*
  | IndexEntry*))
  -(IndexTerm)

Exclusions

Index excludes these elements at every level:

  IndexTerm

Attributes

This element has common and Role attributes.

Tag Minimization

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

Description

Index 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 contains an optional DocInfo, Title, and TitleAbbrev, followed by any number of block-oriented elements, and then one or more IndexEntries or one or more IndexDivs. It has common attributes.

Parents

These elements contain Index: Article, Book, Chapter, Part, Sect1, Sect2, Sect3, Sect4, Sect5.

Children

Index contains these elements: Abstract, Address, Anchor, AuthorBlurb, BlockQuote, BridgeHead, CalloutList, Caution, CmdSynopsis, Comment, DocInfo, Epigraph, Equation, Example, Figure, FormalPara, FuncSynopsis, GlossList, Graphic, GraphicCO, Highlights, Important, IndexDiv, IndexEntry, InformalEquation, InformalExample, InformalTable, ItemizedList, LiteralLayout, MsgSet, Note, OrderedList, Para, Procedure, ProgramListing, ProgramListingCO, Screen, ScreenCO, ScreenShot, SegmentedList, Sidebar, SimPara, SimpleList, Synopsis, Table, Tip, Title, TitleAbbrev, VariableList, Warning.

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

Examples

<INDEX ID="ind123">
<TITLE>Index of Themes</TITLE>
<PARA ID="ind124">The index covers the themes of this book
and is self-referential.</PARA>
<INDEXDIV> 
<TITLE>Big Themes</TITLE>
<INDEXENTRY ID="ind125">
<PRIMARYIE LINKENDS="ind123 ind124">Index</PRIMARYIE>
<SECONDARYIE>of Themes</SECONDARYIE>
<TERTIARYIE>start of</TERTIARYIE>
</INDEXENTRY>
</INDEXDIV> 
<INDEXDIV> 
<TITLE>Little Themes</TITLE>
<INDEXENTRY>
<PRIMARYIE LINKENDS="ind123">Explanations</PRIMARYIE>
<SECONDARYIE>unsatisfactory</SECONDARYIE>
<SEEIE LINKEND="ind125">Index</SEEIE>
<SEEALSOIE LINKENDS="ind123 ind124">Index, first paragraph</SEEALSOIE>
</INDEXENTRY
</INDEXDIV>
</INDEX>
PrevHomeNext
ImportantUpIndexDiv