index
index — An index to a book or part of a book.
Synopsis
- Sequence of:
- One of:
- Zero or more of:
annotation
bridgehead
remark
revhistory
- Indexing inlines
- Admonition elements
- Formal elements
- Graphic elements
- Informal elements
informalequation
informalexample
informalfigure
informaltable
(db.cals.informaltable)informaltable
(db.html.informaltable)
- List elements
- Paragraph elements
- Publishing elements
- Synopsis elements
- Technical elements
- Verbatim elements
- One of:
- Zero or more of:
- Zero or more of:
segmentedlist
- One of:
Additional Constraints
- The root element 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 indexterm
s with a particular
type
will be collected together
in the index
with the same type
.
All indexterm
s, irrespective of their
type
, appear in an
index
that has no type
attribute.
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
Examples
An index
with a title
and
indexdiv
s.
1 <index xmlns='http://docbook.org/ns/docbook'> 2 <title>Index</title> 4 <indexdiv><title>D</title> <indexentry> 6 <primaryie>database (bibliographic), 253, 255</primaryie> <secondaryie>structure, 255</secondaryie> 8 <secondaryie>tools, 259</secondaryie> </indexentry> 10 <indexentry> <primaryie>dates (language specific), 179</primaryie> 12 </indexentry> <indexentry> 14 <primaryie>DC fonts, <emphasis>172</emphasis>, 177</primaryie> <secondaryie>Math fonts, 177</secondaryie> 16 </indexentry> </indexdiv> 18 </index>
An index without a title
or divisions.
1 <index xmlns='http://docbook.org/ns/docbook'> 2 <indexentry> <primaryie>Example</primaryie> 4 <secondaryie>Chapter</secondaryie> <seeie>Example Chapter</seeie> 6 </indexentry> 8 <indexentry> <primaryie>Example Chapter, 35-48</primaryie> 10 <seealsoie>Examples</seealsoie> </indexentry> 12 <indexentry> 14 <primaryie>Examples, 18, 36, 72-133</primaryie> </indexentry> 16 </index>