indexterm (db.indexterm.startofrange)
indexterm — A wrapper for an indexed term that covers a range.
Synopsis
indexterm (db.indexterm.startofrange) ::=
- Sequence of:
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).
Important
The xml:id attribute will be made
required in DocBook V6.0.
A Schematron constraint will be added to assert that for every “start of range” index term, there is exactly one “end of range” index term that points to it.
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 books)
“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
These elements contain indexterm: abbrev, acknowledgements, acronym, address, answer, appendix, article, artpagenums, attribution, authorinitials, bibliocoverage, bibliodiv, bibliography, biblioid, bibliolist, bibliomisc, bibliomixed, bibliomset, bibliorelation, bibliosource, blockquote, bridgehead, callout, calloutlist, caption, chapter, citation, citebiblioid, citetitle, city, colophon, confdates, confnum, confsponsor, conftitle, contractnum, contractsponsor, contrib, country, dedication, dialogue, drama, edition, email, emphasis (db._emphasis), emphasis (db.emphasis), entry, example, fax, figure, firstname, firstterm (db._firstterm), firstterm (db.firstterm), footnote, foreignphrase (db._foreignphrase), foreignphrase (db.foreignphrase), formalpara, givenname, glossary, glossdef, glossdiv, glossentry, glosslist, glosssee, glossseealso, glossterm (db._glossterm), glossterm (db.glossterm), holder, honorific, index, informalexample, informalfigure, informaltable, issuenum, itemizedlist, jobtitle, label, legalnotice, line, lineage, linegroup, link, listitem, literal, literallayout, mathphrase, member, note, olink, optional, orderedlist, orgdiv, orgname, otheraddr, othername, pagenums, para, partintro, personname, phone, phrase (db._phrase), phrase (db.phrase), pob, poetry, postcode, preface, primary, procedure, productname, productnumber, publishername, qandadiv, qandaset, question, quote (db._quote), quote (db.quote), releaseinfo, remark, result, revdescription, revnumber, revremark, secondary, section, see, seealso, seriesvolnums, setindex, shortaffil, sidebar, simpara, simplesect, state, step, street, subscript, subtitle, superscript, surname, table, taskprerequisites, taskrelated, tasksummary, term, termdef, tertiary, textobject, title, titleabbrev, toc, trademark, uri, variablelist, volumenum, wordasword, year.
Examples
<chapter xmlns='http://docbook.org/ns/docbook'>
<title>Example Chapter</title>
<!-- index term for "Example Chapter" is a span -->
<indexterm xml:id="idxexchap" class='startofrange'>
<primary>Example Chapter</primary></indexterm>
<!-- index term for "Example Chapter" also cross references the
"Examples" entry in the index -->
<indexterm><primary>Example Chapter</primary>
<seealso>Examples</seealso></indexterm>
<!-- index term for "Chapter, Example" refers the reader to the entry
under which the index term is actually listed, "Example Chapter" -->
<indexterm><primary>Chapter</primary><secondary>Example</secondary>
<see>Example Chapter</see></indexterm>
<!-- other content -->
<!-- index term, end of "Example Chapter" span -->
<indexterm startref="idxexchap" class="endofrange"/>
<para>some content</para>
</chapter>