wirehaze public archive

Index
DocBook: The Definitive Guide
PrevVersion 1.0.3.Next

Index

Name

Index -- An index

Synopsis

Content Model

Index ::=
((DocInfo?,Title,Subtitle?,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|MediaObject|
  MediaObjectCO|InformalEquation|InformalExample|InformalFigure|
  InformalTable|Equation|Example|Figure|Table|MsgSet|Procedure|
  Sidebar|QandASet|Anchor|BridgeHead|Comment|Highlights|Abstract|
  AuthorBlurb|Epigraph|IndexTerm)*,
 (IndexDiv*|IndexEntry*))

Attributes

Common attributes

Tag Minimization

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

Parameter Entities

%index.class;%nav.class;%partcontehttps://www.rigacci.org/docs/biblio/online/docbook/nt.mix;

Description

An Index contains the formatted indhttps://www.rigacci.org/docs/biblio/online/docbook/ex of a document. An index may begin with introductory material, followed by any number of IndexEntrhttps://www.rigacci.org/docs/biblio/online/docbook/ys or IndexDivs.

Processing expectations

Formatted as a displayed block. An Index in a Book frequently causes a forced https://www.rigacci.org/docs/biblio/online/docbook/page break in print media.

In many processing systems, indexes are generated automatically or semiautomatically and never appear instantiated as DocBook markup.

Parents

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

Children

The following elements occur in Index: Abstract, Address, Anchor, AuthorBlurb, BlockQuote, BridgeHead, CalloutList, Caution, CmdSynopsis, Comment, DocInfo, Epigraph, Equation, Example, Figure, FormalPara, FuncSynopsis, GlossList, Graphic, GraphicCO, Highlights, Important, IndexDiv, IndexEntry, IndexTerm, InformalEquation, Infohttps://www.rigacci.org/docs/biblio/online/docbook/rmalExample, InformalFigure, InformalTable, ItemizedList, LiteralLayout, MediaObject, MediaObjectCO, MsgSet, https://www.rigacci.org/docs/biblio/onhttps://www.rigacci.org/docs/biblio/online/docbook/line/docbook/Note, Ohttps://www.rigacci.org/docs/biblio/online/docbook/rderedList, Para, Procedure, ProgramListing, ProgramListingCO, QandASet, Screen, ScreenCO, ScreenShot, SegmentedList, Sidebar, SimPara, SimpleList, Subtitle, Synopsis, Table, Tip, Title, TitleAbbrev, VariableList, Warning.

In some conhttps://www.rigacci.org/docs/biblio/online/docbook/texts, the following elements are allowed anywhere: BeginPage.

Examples

<!DOCTYPE index PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<index><title>Index</title>
<indexdiv><title>D</title>
<indexentry>
  <primaryie>database (bibliographic), 253, 255</primaryie>
  <secondaryie>structure, 255</secondaryie>
  <secondaryie>tools, 259</secondaryie>
</indexentry>
<indexentry>
  <primaryie>dates (language specific), 179</primaryie>
</indexentry>
<indexentry>
  <primaryie>DC fonts, <emphasis>172</emphasis>, 177</primaryie>
  <secondaryie>Math fonts, 177</secondaryie>
</indexentry>
</indexdiv>
</index>
<!DOCTYPE index PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<index>
<indexentry>
  <primaryie>Example</primaryie>
  <secondaryie>Chapter</secondaryie>
  <seeie>Example Chapter</seeie>
</indexentry>

<indexentry>
  <primaryie>Example Chapter, 35-48</primaryie>
  <seealsoie>Examples</seealsoie>
</indexentry>

<indexentry>
  <primaryie>Examples, 18, 36, 72-133</primaryie>
</indexentry>

</index>
PrevHomeNext
ImportantUpIndhttps://www.rigacci.org/docs/biblio/online/docbook/exDiv

Copyright © 1999 O'Reilly &https://www.rigacci.org/docs/biblio/online/docbook/amp; Associates, Inc. All righthttps://www.rigacci.org/docs/biblio/online/docbook/s reserved.

04!è1997-01-20 15:17 43K  [IMG]25tig05.gif1997-01-20 15:17 13K  [IMG]25tig06.gif1997-01-20 15:17 9.5K  [IMG]bluindex.gif1997-01-20 14:48