Indexing group elements

The indexing domain provides several new elements for use with indexing. The new elements allow authors to define "See" and "See also" references, and to override the default sort order for a term.

Indexing domain elements typically work with the indexterm and index-base elements; index-base is grouped with elements that are typically useful only in specialization contexts, and can be found using the link below.

3.1.3.2.1 indexterm
The content of an <indexterm> element is used to produce an index entry in the generated index. You can nest indexterm elements to create multi-level indexes. The content is not output as part of the topic content, only as part of the index.
3.1.3.2.2 indextermref
This element is not completely defined; it is reserved for future use.
3.1.3.2.3 index-see
An <index-see> element within an <indexterm> redirects the reader to another index entry that the reader should reference instead of the current one.
3.1.3.2.4 index-see-also
An <index-see-also> element within an <indexterm> redirects the reader to another index entry that the reader should reference in addition to the current one.
3.1.3.2.5 index-sort-as
The <index-sort-as> element specifies a sort phrase under which an index entry would be sorted.

Parent topic: 3.1.3 Metadata elements

Previous topic: 3.1.3.1.27 vrm

Next topic: 3.1.3.2.1 indexterm

Related reference

3.1.6.5 index-base

Return to main page.

3.1.3.2 Indexing group elements