Index Term

The index term to be embedded into the narrative of a document so that an Index can be created programmatically.


Index entries are recursive, so if a category (“drinks”) contains a sub-category (“lemonade”), the category <index-term> will contain two components:
  • its own <term> (“drinks”), and
  • an <index-term> for the sub-category. This subordinate index term will contain its own <term> (“lemonade”).
An <index-term> is either a single target point or the start of an index range. When it is the start of a range, an @id attribute is required, so that the <index-term-range-end> element can point to the start of the range.


Content Model

<!ELEMENT index-term    %index-term-model;                           >

Expanded Content Model

(term, (index-term | (see | see-also)*))


The following, in order:

This element may be contained in:

<abbrev>, <addr-line>, <aff>, <alt-title>, <anonymous>, <article-title>, <attrib>, <award-id>, <bold>, <book-title>, <book-volume-id>, <book-volume-number>, <chapter-title>, <chem-struct>, <code>, <collab>, <comment>, <compound-kwd-part>, <conf-acronym>, <conf-loc>, <conf-name>, <conf-num>, <conf-sponsor>, <conf-theme>, <copyright-statement>, <corresp>, <def-head>, <degrees>, <disp-formula>, <edition>, <element-citation>, <email>, <etal>, <ext-link>, <fax>, <fixed-case>, <funding-source>, <funding-statement>, <given-names>, <gov>, <index-term>, <inline-formula>, <inline-supplementary-material>, <institution>, <issue>, <issue-part>, <issue-title>, <italic>, <kwd>, <label>, <license-p>, <meta-name>, <meta-value>, <mixed-citation>, <monospace>, <named-content>, <nav-pointer>, <on-behalf-of>, <overline>, <p>, <part-title>, <patent>, <phone>, <prefix>, <preformat>, <product>, <publisher-loc>, <publisher-name>, <rb>, <related-article>, <related-object>, <role>, <roman>, <sans-serif>, <sc>, <see>, <see-also>, <see-also-entry>, <see-entry>, <self-uri>, <series>, <serif>, <sig>, <sig-block>, <source>, <speaker>, <std-organization>, <strike>, <string-conf>, <string-date>, <string-name>, <styled-content>, <sub>, <subject>, <subtitle>, <suffix>, <sup>, <supplement>, <surname>, <target>, <td>, <term>, <term-head>, <th>, <title>, <trans-source>, <trans-subtitle>, <trans-title>, <underline>, <unstructured-kwd-group>, <uri>, <verse-line>, <version>, <volume>, <volume-id>, <volume-series>, <volume-title>, <xref>

Example 1

An index term inside narrative text:
<p>However, the First Amendment does not bar the 
issuance or execution of a warrant to search a newsroom
and press</see-also></index-term> to obtain photographs 
of demonstrators who had injured several policemen, 
although the Court appeared to suggest ...</p>

Example 2

An index term inside a title:
<sec id="sec10-3-3">
<title>Interstate Compacts<index-term id="idx313"><term>Interstate 
compacts</term><see>States, Agreements with other States</see>
<sec id="sec10-3-3-1">...</sec>
<sec id="sec10-3-3-2">
<title content-type="run-in">Subject Matter of Interstate Compacts</title>
<p>For many years after the Constitution was adopted, boundary 
disputes continued to predominate as the subject matter of agreements 
among the States.  Since the turn of the twentieth century, however, the 
interstate compact has been used to an increasing extent as an instrument 
for state cooperation ...</p>
...<sec id="sec10-3-3-5">
<title content-type="run-in">Legal Effect of Interstate Compacts</title>
<p>Whenever, by the agreement of the States concerned and the 
consent of Congress, an interstate compact comes into operation, it 
has the same effect as ... <index-term-range-end rid="idx313"/></p>

Example 3

Multi-level index terms:
<p>This is a paragraph with indexing throughout.  For example, it 
shows primary index terms<index-term><term>primary level index 
term</term></index-term>, and then continues with embedded 
index terms such as this one.
<index-term><term>primary level index term</term>
<index-term><term>secondary term</term></index-term>
</index-term> as the text continues.</p>

<p>Now that you see how it works, this paragraph is slightly 
more realistic.  It talks about Poodles, for example, <index-term>
<term>poodle</term></index-term>, and then continues on 
with other embedded index terms such as this 2-level one.
</index-term> The text continues, if necessary.</p>

<p>Finally, as an illustration, this is a very complex, multilevel 
index term
  <term>primary term</term>
      <term>secondary term</term>
          <term>tertiary term</term>
              <term>4th level down</term>
                  <term>5th and out</term>
                    <see>a lessor, non-preferred term</see>
                    <see-also>Be advised you might want to look 
                    at this.</see-also>
</index-term> inside the text of an ordinary paragraph.
Or placed at the end of the paragraph, if that seems
more reasonable.</p>