indexterm

An <indexterm> is an index entry. You can nest entries to create multi-level indexes. The content is not output as part of topic content, only as part of the index.

When DITA topics are output to XHTML, any indexterm elements in the <keywords> element are placed in the Web page metadata, in addition to becoming part of the generated index.

Contains

( text data or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or term or indexterm) (any number)

Contained by

section, example, p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, keywords, indexterm, prereq, context, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, screen, codeblock, pd

Inheritance

topic/indexterm

Attributes

Name Description Data Type Default Value Required?
keyref Currently not implemented in DITA processors. Provides a key that a process can use to identify a higher-level index term that the current index term should be added under. NMTOKEN #IMPLIED No
%univ-atts; (%select-atts;, %id-atts;, translate, xml:lang) A set of related attributes, described at %univ-atts; parameter entity PE not applicable Not applicable
%global-atts; (xtrf, xtrc) A set of related attributes, described at %global-atts; parameter entity PE not applicable Not applicable
class A common attribute described in Other common DITA attributes

Example

<purpose>An indexterm is an index entry. You can nest entries to 
create multi-level indexes.<indexterm>indexterm</indexterm>
<indexterm>Valid in Many Places elements<indexterm>indexterm</indexterm>
</indexterm></purpose>