#### 14.9.5 Mapping indexterms to variant indexes

Each indexterm you want to include in a variant indexlist must be immediately preceded in your DITA source by a PI of the form:

    <?dtall outputclass="variantname" ?>

This is because the outputclass attribute is not allowed on indexterm. See §38.1.1 Understanding DITA2Go PI marker syntax.

For indexlist variants, in addition to names and properties, you need settings to accomplish the following:

Map outputclass values to variants

List outputclass values for each variant.

Map outputclass values to variants

To map outputclass PI values to the indexlist variants named in [BookLists] (see §14.9.2 Naming variant booklist components):

    [IndexClasses]
    ; indexterm outputclass PI = name(s) of indexlist variant(s)

In addition to names of indexlist variants, you can use as values two predefined flags:

IDX | Identifies the normal index
NoIDX | Omits from all indexes the content of any indexterms with the specified outputclass value

An indexterm with an outputclass PI value mapped in [IndexClasses] is included only in the indexlist variants to which it is mapped; if the IDX flag is in the list of variants, that includes the normal index. You need the NoIDX flag only for those indexterms you do not want in any index.

You can map an outputclass value to more than one indexlist variant. For example:

    [IndexClasses]
    Subject = TestIX IDX
    Test = TestIX
    Skip = NoIDX

An indexterm is included only in the normal index if it has any of the following:

- an outputclass PI value mapped only to IDX
- an outputclass PI value that is not mapped
- no outputclass PI.

List outputclass values for each variant

To specify the outputclass PI values of indexterms to include in each indexlist variant:

    [IndexLists]
    ; indexlist name = outputclass PI values to include
    TestIX = Subject Test

The normal index includes the content of all indexterms with the following characteristics:

- no outputclass PI
- an outputclass PI value not mapped in [IndexClasses]
- an outputclass PI value mapped to IDX in [IndexClasses].

To omit an indexterm from all indexes, give the indexterm element an outputclass PI, and map the value to NoIDX in [IndexClasses].

Previous Topic: 14.9.4 Defining properties of items in variant booklist components

Next Topic: II. Configuring print RTF output

Parent Topic: 14.9 Configuring variant booklist components

Sibling Topics:

14.9.1 Differentiating variant booklist components

14.9.2 Naming variant booklist components

14.9.3 Specifying properties of variant booklist components

14.9.4 Defining properties of items in variant booklist components

Table of Contents • Index