indexterm (db.indexterm.startofrange)

indexterm — A wrapper for an indexed term that covers a range.

Synopsis

Sequence of:
- primary?
- Optionally one of:
  - Sequence of:
    secondary
    Optionally one of:
    Sequence of:
    tertiary
    Optionally one of:
    One or more of:
    seealso
    see
    One or more of:
    seealso
    see
  - One or more of:
    seealso
  - see

Attributes

Common attributes and common linking attributes.

Additional attributes:

class (enumeration)
- “startofrange”
pagenum
scope (enumeration)
- “all”
- “global”
- “local”
significance (enumeration)
- “normal”
- “preferred”
type
zone (IDREFS)

Required attributes are shown in bold.

Description

A “start of range” indexterm marks the start of a range. It must have an associated “end of range” indexterm. The resulting index entry applies to the entire range. See indexterm (db.indexterm.singular).

Processing expectations

See indexterm (db.indexterm.singular).

It is possible to construct index terms that are difficult to parse at best and totally illogical at worst. Consider the following:

<indexterm class='startofrange' zone="id1 id2">...</indexterm>

There is no way that this can fit into the semantics of an indexterm. Although it claims to be the start of a range, it does not have an xml:id for the end-of-range indexterm to point back to. In addition, it includes zoned terms, and mixing the two different methods for indicating a range in the same indexterm is probably a bad idea.

Attributes

Common attributes and common linking attributes.

class

Identifies the class of index term

Enumerated values:
“startofrange”	The start of a range

pagenum

Indicates the page on which this index term occurs in some version of the printed document

scope

Specifies the scope of the index term

Enumerated values:
“all”	All indexes
“global”	The global index (as for a combined index of a set of box)
“local”	The local index (the index for this document only)

significance

Specifies the significance of the term

Enumerated values:
“normal”	Normal
“preferred”	Preferred

type

Specifies the target index for this term

zone

Specifies the IDs of the elements to which this term applies

Parents

This element occurs in 243 elements.

Children

The following elements occur in indexterm: primary, secondary, see, seealso, tertiary.

Examples

  1 <chapter xmlns='http://docbook.org/ns/docbook'>
  2 <title>Example Chapter</title>
    
  4 <!-- index term for "Example Chapter" is a span -->
    <indexterm xml:id="idxexchap" class='startofrange'>
  6   <primary>Example Chapter</primary></indexterm>
    
  8 <!-- index term for "Example Chapter" also cross references the 
         "Examples" entry in the index -->
 10 <indexterm><primary>Example Chapter</primary>
      <seealso>Examples</seealso></indexterm>
 12 
    <!-- index term for "Chapter, Example" refers the reader to the entry
 14      under which the index term is actually listed, "Example Chapter" -->
    <indexterm><primary>Chapter</primary><secondary>Example</secondary>
 16   <see>Example Chapter</see></indexterm>
    
 18 <!-- other content -->
    
 20 <!-- index term, end of "Example Chapter" span -->
    <indexterm startref="idxexchap" class="endofrange"/>
 22 
    <para>some content</para>
 24 </chapter>


indexterm (db.indexterm.singular)		info (db.info)