indexterm — Identifies the end of a range associated with an indexed term
indexterm (db.indexterm.endofrange) ::=
Common attributes and common linking attributes.
Additional attributes:
Required attributes are shown in bold.
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.
The indexterm
s mark 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 id
. Place another indexterm
at the end of the range with startref
pointing to the 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 indexterm
s can be collected together or even stored totally outside the flow of the document (in the meta for example).
The indexterm
s 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.
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 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.
Common attributes and common linking attributes.
Identifies the class of index term
Enumerated values: | |
---|---|
“endofrange” |
The end of a range |
Points to the start of the range
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
, 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.singular), primary
, primaryie
, secondary
, secondaryie
, see
, seealso
, seealsoie
, seeie
, tertiary
, tertiaryie