index

index — An index to a book or part of a book.

Synopsis

index ::= [-]

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

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 indexterms with a particular type will be collected together in the index with the same type.

All indexterms, 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

Parents

These elements contain index: appendix, article, book, chapter, part, preface, section.

Children

Examples

An index without a title.

<index xmlns='http://docbook.org/ns/docbook'>
<indexentry>
  <primaryie>Example</primaryie>
  <secondaryie>Chapter</secondaryie>
  <seeie>Example Chapter</seeie>
</indexentry>

<indexentry>
  <primaryie>Example Chapter, 35-48</primaryie>
  <seealsoie>Examples</seealsoie>
</indexentry>

<indexentry>
  <primaryie>Examples, 18, 36, 72-133</primaryie>
</indexentry>

</index>
Last revised by Norman Walsh on (git hash: c3457cab689d8fd89ba4252de204cf9a14e40acd 6a501344525f32f9834f0e4a5c3c3f8131803fa4 47fe34b28bad7941a61b9c1c17d47f6eed36cd04)
https://tdg.docbook.org/tdg/publishers/5.0/index-db.html
tdg.docbook.org
crawl=CC-MAIN-2019-09
28441
application/http; msgtype=response
sha1:KTDWRO7HJ3PCAR2YEA2CFLEM5SWVSGL3
<urn:uuid:65196e2d-aac0-4eea-a77f-98fbfeaf114f>
2019-02-16T06:01:55Z
142.93.122.177
application/xhtml+xml
sha1:KIZXIHNQSJM3A5KUJAD2PD744EWQ7BBV
<urn:uuid:be72ddc9-3400-41ca-b8ca-7a948352348c>
https://tdg.docbook.org/tdg/publishers/5.0/index-db.html
response
<urn:uuid:23c6dde0-0b92-4ea9-9195-642d640b88f7>
isPartOf: CC-MAIN-2019-09
publisher: Common Crawl
description: Wide crawl of the web for February 2019
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-140-176-207.ec2.internal
software: Apache Nutch 1.15 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 0.11-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: http://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/