indexentry
indexentry — An entry in an index.
Synopsis
- Sequence of:
primaryie- Zero or more of:
- Zero or more of:
- Sequence of:
secondaryie- Zero or more of:
- Sequence of:
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.
Parents
These elements contain indexentry: index, indexdiv, setindex.
Children
The following elements occur in indexentry: primaryie, secondaryie, seealsoie, seeie, tertiaryie.
See Also
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"> 2 <indexdiv> 4 <title>E</title> 6 <indexentry> <primaryie>Entering markup, 14, 18, 22-33</primaryie> 8 </indexentry> 10 <indexentry> <primaryie>eSATA, 56, 58-61</primaryie> 12 <seealsoie>Serial ATA</seealsoie> </indexentry> 14 <indexentry> 16 <primaryie>evaluating expressions, 44</primaryie> </indexentry> 18 </indexdiv> 20 <indexdiv> <title>U</title> 22 <indexentry> 24 <primaryie>Ubiquitous networking, 34, 44, 173-199</primaryie> </indexentry> 26 <indexentry> 28 <primaryie>Universal Serial Bus, 50-55</primaryie> </indexentry> 30 <indexentry> 32 <primaryie>Up time, 2, 5</primaryie> </indexentry> 34 <indexentry> 36 <primaryie>USB</primaryie> <seeie>Universal Serial Bus</seeie> 38 </indexentry> </indexdiv> 40 </index>