Indexing Overview

1. Create the index definition object that will format your index and define its scope. Refer to Indexes List for information.

2. Configure the element that will output the index in your output. Set its parameters, for example the index definition object that will format it, and the language to which it should be sorted. Refer to the Index Details Dialog Box for further information.

3. Configure the elements that define index terms, based on one of the models listed below. Select the index definition object and define the roles each of the elements will perform in the index term.

There are three methods for designating content as index terms for an index, depending on the type of document you are working with:

◦ If your document type includes a set of index term elements, such as primary, secondary, and tertiary, with a wrapper element such as indexterm that encloses them, you will use the Element Model for creating an index. See Creating an Index with Element Model Index Terms for information.

◦ Some document types, such as the CALS, allow for only one index element, and you specify that the attributes of that element will form the content of that index. Here you will create the index according to the Attribute Model. See Creating an Index with Attribute Model Index Terms for information.

◦ Other document types, such as the Darwin Information Typing Architecture (DITA), allow for only one index element and nest that element to determine whether it is a primary, secondary, or tertiary index entry. In this case you will follow the Nesting Element Model. See Creating a Index with Nesting Element Model Index Terms for information.

◦ You may also create See, See Also index terms or request that index terms should be included under a non-alphabetic heading. Refer to Creating See and See-Also Index Terms and Configuring Alternative Sorting of Index Terms for further information.

A single index can contain index terms from different models. You can also create index terms that might show up in multiple indexes.

• You can configure multiple indexes for a single document. You can scope the indexes to appear within certain parts of the document, and include the index terms defined in that part, for example chapter or section level indexes. Refer to Configuring Multiple Indexes for a Document for further information.

• An index can include elements not styled as its index terms. Refer toIncluding Elements not Styled as Index Terms in an Index for further information.

• You can also specify the language to which your index content should be sorted. Specify the language to be used in the Index Details Dialog Box.

The following output limitations should be noted when working with indexes:

• The index-see-also element is supported in all outputs. For RTF output, you must manually enter the text See Also, or equivalent, as content of the index term to ensure it is output correctly. This is a limitation of MS Word.

This can be accomplished via an output property in the definition of the _sfe:IndexSeeAlso element.

• The index-sort-as element is not supported for RTF output. This is a limitation of MS Word.