index

index — An index to a book or part of a book.

Synopsis

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • label
  • status
  • type

Additional Constraints

  • The root element must have a version attribute.

Description

An index contains the formatted index of a document.

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.

Often an empty index is used to indicate where the automatically generated index should be rendered.

Authors can choose to have several types of indexes: for example, function, command, and concept indexes. This can be achieved in DocBook with the type attribute. All of the indexterms with a particular type will be collected together in the index with the same type.

All indexterms, irrespective of their type, appear in an index that has no type attribute.

Attributes

Common attributes and common linking attributes.

label

Specifies an identifying string for presentation purposes

status

Identifies the editorial or publication status of the element on which it occurs

type

Specifies the target index for this term

Parents [+]

This element occurs in 13 elements.

Children [+]

This element contains 66 elements.

Examples

An index with a title and indexdivs.

  1 <index xmlns='http://docbook.org/ns/docbook'>
  2 <title>Index</title>
    
  4 <indexdiv><title>D</title>
    <indexentry>
  6   <primaryie>database (bibliographic), 253, 255</primaryie>
      <secondaryie>structure, 255</secondaryie>
  8   <secondaryie>tools, 259</secondaryie>
    </indexentry>
 10 <indexentry>
      <primaryie>dates (language specific), 179</primaryie>
 12 </indexentry>
    <indexentry>
 14   <primaryie>DC fonts, <emphasis>172</emphasis>, 177</primaryie>
      <secondaryie>Math fonts, 177</secondaryie>
 16 </indexentry>
    </indexdiv>
 18 </index>

An index without a title or divisions.

  1 <index xmlns='http://docbook.org/ns/docbook'>
  2 <indexentry>
      <primaryie>Example</primaryie>
  4   <secondaryie>Chapter</secondaryie>
      <seeie>Example Chapter</seeie>
  6 </indexentry>
    
  8 <indexentry>
      <primaryie>Example Chapter, 35-48</primaryie>
 10   <seealsoie>Examples</seealsoie>
    </indexentry>
 12 
    <indexentry>
 14   <primaryie>Examples, 18, 36, 72-133</primaryie>
    </indexentry>
 16 
    </index>
Last revised by Norman Walsh on 16 Jun 2011 (git hash: 7cf44d0f3aa4244c54913b42ac9cc634bd9b7fc9)