index

index — An index

Synopsis

Content Model

index ::=
(indexinfo?,
 (title,subtitle?,titleabbrev?)?,
 (calloutlist|glosslist|bibliolist|itemizedlist|orderedlist|
  segmentedlist|simplelist|variablelist|caution|important|note|
  tip|warning|literallayout|programlisting|programlistingco|
  screen|screenco|screenshot|synopsis|cmdsynopsis|funcsynopsis|
  classsynopsis|fieldsynopsis|constructorsynopsis|
  destructorsynopsis|methodsynopsis|formalpara|para|simpara|
  address|blockquote|graphic|graphicco|mediaobject|mediaobjectco|
  informalequation|informalexample|informalfigure|informaltable|
  equation|example|figure|table|msgset|procedure|sidebar|qandaset|
  task|productionset|constraintdef|anchor|bridgehead|remark|
  highlights|abstract|authorblurb|epigraph|indexterm|beginpage)*,
 (indexdiv*|indexentry*))

Attributes

Common attributes

Name	Type	Default
type	CDATA	None

Description

An Index contains the formatted index of a document. An index may begin with introductory material, followed by any number of IndexEntrys or IndexDivs.

Processing expectations

Formatted as a displayed block. An Index in a Book frequently causes a forced page break in print media.

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

Future Changes

Formal objects and other elements inappropriate for an index will be removed from the content that can appear before the first IndexDiv or IndexEntry.

Parents

These elements contain index: appendix, article, book, chapter, part, preface, sect1, sect2, sect3, sect4, sect5, section.

Children

The following elements occur in index: abstract, address, anchor, authorblurb, beginpage, bibliolist, blockquote, bridgehead, calloutlist, caution, classsynopsis, cmdsynopsis, constraintdef, constructorsynopsis, destructorsynopsis, epigraph, equation, example, fieldsynopsis, figure, formalpara, funcsynopsis, glosslist, graphic, graphicco, highlights, important, indexdiv, indexentry, indexinfo, indexterm, informalequation, informalexample, informalfigure, informaltable, itemizedlist, literallayout, mediaobject, mediaobjectco, methodsynopsis, msgset, note, orderedlist, para, procedure, productionset, programlisting, programlistingco, qandaset, remark, screen, screenco, screenshot, segmentedlist, sidebar, simpara, simplelist, subtitle, synopsis, table, task, tip, title, titleabbrev, variablelist, warning.

Examples

<!DOCTYPE index PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<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 XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<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>