The <index-base> element allows indexing extensions to be added by specializing this element.
The <index-base> element can only exist as a child of an <indexterm> element. This characteristic makes it the appropriate element to specialize to add indexing extensions. For example, the index-see, index-see-also, and index-sort-as elements only make sense as children of <indexterm> and so are specializations of <index-base>. Those elements are all part of the indexing domain.
On its own, <index-base> has no meaning. Processors should ignore this element and its content if encountered in its unspecialized form.
| Doctype | Content model |
|---|---|
| topic (base), map (base), classifyMap, subjectScheme, learningAssessment, learningBookmap, learningContent, learningMap, learningOverview, learningPlan, learningSummary | ( text data or data or data-about or foreign or unknown or keyword or term or indexterm) (any number) |
| topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap | ( text data or data or data-about or foreign or unknown or keyword or apiname or option or parmname or cmdname or msgnum or varname or wintitle or term or abbreviated-form or indexterm) (any number) |
| machineryTask | ( text data or data or data-about or foreign or unknown or keyword or wintitle or term or indexterm) (any number) |
| Doctype | Content model |
|---|---|
| topic (base), map (base), topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task (strict), task (general), bookmap, classifyMap, subjectScheme, machineryTask, learningAssessment, learningBookmap, learningContent, learningMap, learningOverview, learningPlan, learningSummary | indexterm |
The <index-see-also> element is specialized from index-base; see index-see-also for an example of how index-base may be used with specialization.
| Name | Description | Data Type | Default Value | Required? |
|---|---|---|---|---|
| keyref | Keyref provides a redirectable reference based on a key defined within a map. See The keyref attribute for information on using this attribute. | CDATA | #IMPLIED | No |
| univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups) | A set of related attributes, described in univ-atts attribute group | |||
| global-atts attribute group (xtrf, xtrc) | A set of related attributes, described in global-atts attribute group | |||
| class | A common attribute described in Other common DITA attributes |
Return to main page.
DITA v1.2 CS 01
Copyright © OASIS Open 2005, 2010. All Rights Reserved.