DocBook 5: The Definitive Guide

Name

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

Synopsis

index ::= ((((title? & titleabbrev? & subtitle?), info? ^{db.titleforbidden.info}) | info? ^db.info), (annotation | bridgehead | remark | revhistory | Indexing inlines | Admonition elements | Formal elements | Graphic elements | Informal elements | List elements | Paragraph elements | Publishing elements | Synopsis elements | Technical elements | Verbatim elements)*, (indexdiv* | indexentry* | segmentedlist))

Attribute synopsis

Common attributes and common linking attributes.

Additional attributes:

label
status
type

Additional constraints

If this element is the root element, it 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.