indextermref

An <indextermref> is a reference to an index entry in a lookup table used by the indexing process. If you want to create index markers pointing to referenced items, but only want page numbers instead of separate index entries to be generated, use the index term reference <indextermref> element. This adds the page number of the reference to the index without creating a separate index entry.

Note: Not currently supported in DITA processing. Since the equivalent processing can be provided by simply duplicating the target indexterm (or by creating an indexterm element with a conref attribute pointing to the target), this element might be deprecated in the future.

Contains

no content

Contained by

section, example, p, note, lq, sli, li, itemgroup, dd, pre, lines, ph, stentry, entry, 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/indextermref

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 the indexterm which the current location should be added to.	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

<p>Use <indextermref keyref="yellow"/> lemon zest to add a tangy citrus 
flavor to the cake icing.</p>