IndexEntry

DocBook: The Definitive Guide
Prev	Version 1.0.3.	Next

Synopsis

Content Model

IndexEntry ::=
(PrimaryIE,
 (SeeIE|SeeAlsoIE)*,
 (SecondaryIE,
  (SeeIE|SeeAlsoIE|TertiaryIE)*)*)

Attributes

Common attributes

Tag Minimization

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

Description

An IndexEntry wraps all of the index terms associated with a particular primary index term. This includes an arbitrary list of secondary and tertiary elements as well as See and SeeAlso elements.

Processing expectations

Formatted as a displayed block. A rendered index usually places secondary items under primary items and tertiary items under secondary.

Parents

These elements contain IndexEntry: Index, IndexDiv, SetIndex.

Children

The following elements occur in IndexEntry: PrimaryIE, SecondaryIE, SeeAlsoIE, SeeIE, TertiaryIE.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.