    |
DocBook: The Definitive Guide 0.0.25 for DocBook V5.0 (Alpha) |
| |
DocBook: The Definitive Guide 0.0.25 for DocBook V5.0 (Alpha) |
indexterm — A wrapper for an indexed term
indexterm (db.indexterm.singular) ::=
Common attributes and common linking attributes.
Additional attributes:
An indexterm identifies text that is to be placed in the index. In the simplest case, the placement of the indexterm in the document identifies the location of the term in the text. In other words, the indexterm is placed in the flow of the document at the point where the indexentry in the index should point. In other cases, attributes on indexterm are used to identify the location of the term in the text.
An indexterm marks either a single point in the document or a range. A single point is marked with an indexterm placed in the text at the point of reference. There are two ways to identify a range of text:
Place an indexterm at the beginning of the range with class set to startofrange and give this term an xml:id. Place another indexterm at the end of the range with startref pointing to the xml:id of the starting indexterm. This second indexterm must be empty.
The advantage of this method is that the range can span unbalanced element boundaries.
Place the indexterm anywhere you like and point to the element that contains the range of text you wish to index with the zone attribute on the indexterm. Note that zone is defined as IDREFS so a single indexterm can point to multiple ranges.
The advantage of this method is that indexterms can be collected together or even stored totally outside the flow of the document (in the info for example).
indexterms are suppressed in the primary text flow, although they contribute to the population of an index and serve as anchors for cross references. Under no circumstances is the actual content of indexterm rendered in the primary flow.
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.
Common attributes and common linking attributes.
Identifies the class of index term
| Enumerated values: | |
|---|---|
| “singular” |
A singular index term |
Indicates the page on which this index term occurs in some version of the printed document
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) |
Specifies the significance of the term
| Enumerated values: | |
|---|---|
| “normal” |
Normal |
| “preferred” |
Preferred |
Specifies the target index for this term
Specifies the IDs of the elements to which this term applies
These elements contain indexterm: abbrev, accel, acknowledgements, acronym, address, annotation, answer, appendix, application, arg, article, artpagenums, attribution, authorinitials, bibliocoverage, bibliodiv, bibliography, biblioid, bibliolist, bibliomisc, bibliomset, bibliorelation, bibliosource, blockquote, bridgehead, callout, calloutlist, caption (db.caption), caption (db.html.caption), caution, chapter, citation, citebiblioid, citetitle, city, classname, classsynopsisinfo, code, colophon, command, computeroutput,
confdates, confnum, confsponsor, conftitle, constant, constraintdef, contractnum, contractsponsor, contrib, country, database, dedication, edition,
email, emphasis (db._emphasis), emphasis (db.emphasis), entry, envar, errorcode, errorname, errortext, errortype, example, exceptionname, fax, figure, filename, firstname, firstterm, footnote, foreignphrase, formalpara, funcdef, funcparams, funcsynopsisinfo, function, glossary, glossdef,
glossdiv, glossentry, glosslist, glosssee, glossseealso, glossterm, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, hardware, holder, honorific, html:button, html:fieldset, html:form, html:label, html:legend, important, index, indexdiv, informalexample, informalfigure, informaltable (db.cals.informaltable), initializer, interfacename, issuenum, itemizedlist, itermset, jobtitle, keycap, keycode, keysym, label, legalnotice, lineage,
lineannotation, link, listitem, literal, literallayout, manvolnum, markup, mathphrase, member, methodname, modifier, mousebutton, msgaud, msgexplan, msglevel, msgorig, msgtext, note, olink, option, optional, orderedlist, orgdiv, orgname, otheraddr, othername, package, pagenums, para, paramdef, parameter, partintro, personname, phone, phrase (db._phrase), phrase (db.phrase), pob, postcode, preface,
primary, primaryie, procedure, productname, productnumber, programlisting, prompt, property, publishername, qandadiv, qandaset, question, quote, refdescriptor, refentry, refentrytitle, refmeta, refmiscinfo, refname,
refpurpose, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, releaseinfo, remark, replaceable, returnvalue, revdescription, revnumber, revremark, screen, secondary, secondaryie, sect1, sect2, sect3, sect4, sect5, section, see, seealso, seealsoie, seeie, seg, segtitle, seriesvolnums, setindex, shortaffil, sidebar, simpara, simplesect, state, step, street, subscript, subtitle, superscript,
surname, symbol, synopsis, systemitem, table (db.cals.table), tag, taskprerequisites, taskrelated, tasksummary, td, term, termdef, tertiary, tertiaryie, textobject, th, tip, title, titleabbrev, toc, tocdiv, tocentry, token, trademark, type, uri, userinput, variablelist, varname, volumenum, warning, wordasword, year.
indexentry, indexterm (db.indexterm.startofrange), primary, primaryie, secondary, secondaryie, see, seealso, seealsoie, seeie, tertiary, tertiaryie<article xmlns='http://docbook.org/ns/docbook'> <title>Example indexterm</title> <para>The Tiger<indexterm> <primary>Big Cats</primary> <secondary>Tigers</secondary></indexterm> is a very large cat indeed. </para> </article>
An example of a zone.
<chapter xmlns='http://docbook.org/ns/docbook'> <title>Example Chapter</title> <indexterm zone="a1"><primary>Network Configuration</primary></indexterm> <!-- other content here --> <section xml:id="a1"><title>Configuring Your Network</title> <para>…</para> </section> </chapter>
| |
|
|
| indexterm (db.indexterm.endofrange) | |
indexterm (db.indexterm.startofrange) |