DocBook 5.1: The Definitive Guide  (Version 1.5.3 for DocBook 5.1)

setindex

setindex — An index to a set of books.

Synopsis

setindex ::= [-]

Attributes

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

A setindex contains the formatted index of a complete set of books. 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 set usually 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.

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

These elements contain setindex: set.