indexentry

indexentry — An entry in an index.

Synopsis

indexentry ::=

Attributes

Common attributes and common linking attributes.

No additional attributes.

Description

An indexentry is a wrapper for index terms as they appear in an index. It’s the markup used for creating a back-of-the-book index. To identify index terms in the flow of the text, use indexterm.

The content of an indexentry is the collated, formatted list of terms and cross-references.

Processing expectations

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

It is very uncommon to construct an index explicitly with indexentry markup. Indexes are almost always generated automatically from embedded indexterm markup in the document.

Attributes

Common attributes and common linking attributes.

any attribute

Any attribute in any other explicit namespace

Parents

These elements contain indexentry: index, indexdiv, setindex.

Children

The following elements occur in indexentry: primaryie, secondaryie, seealsoie, seeie, tertiaryie.

See Also

Related elements: indexterm, primary, primaryie, secondary, secondaryie, see, seealso, seealsoie, seeie, tertiary, tertiaryie.

Examples

Here's how the example indexes from the indexterm description might be represented using indexentry markup: 

 1 |<index xmlns="http://docbook.org/ns/docbook">
   | 
   |<indexdiv>
   |<title>E</title>
 5 | 
   |<indexentry>
   |<primaryie>Entering markup, 14, 18, 22-33</primaryie>
   |</indexentry>
   | 
10 |<indexentry>
   |<primaryie>eSATA, 56, 58-61</primaryie>
   |<seealsoie>Serial ATA</seealsoie>
   |</indexentry>
   | 
15 |<indexentry>
   |<primaryie>evaluating expressions, 44</primaryie>
   |</indexentry>
   |</indexdiv>
   | 
20 |<indexdiv>
   |<title>U</title>
   | 
   |<indexentry>
   |<primaryie>Ubiquitous networking, 34, 44, 173-199</primaryie>
25 |</indexentry>
   | 
   |<indexentry>
   |<primaryie>Universal Serial Bus, 50-55</primaryie>
   |</indexentry>
30 | 
   |<indexentry>
   |<primaryie>Up time, 2, 5</primaryie>
   |</indexentry>
   | 
35 |<indexentry>
   |<primaryie>USB</primaryie>
   |<seeie>Universal Serial Bus</seeie>
   |</indexentry>
   |</indexdiv>
40 |</index>