17.16.5.29 INDEX

Description: Builds an index using the index entries specified by XE fields (17.16.5.72), and inserts that index at this place in the document. Each index entry and subentry is a separate paragraph unless the \r switch is used, in which case, an index entry and all its subentries together make up a paragraph.

Field Value: The index.

Switches: Zero or more of the following field-specific-switches.

\b field-
argument

Builds an index for the portion of the document marked by the bookmark indicated by text in this switch’s field-argument.

\c field-
argument

Builds an index having the number of columns per page specified by text in this switch’s field- argument. That number can be 1–4. Without this switch, the number of columns is 1.

\d field-
argument

The text in this switch’s field-argument specifies a sequence of characters that is used to separate sequence numbers and page numbers when the \s switch is used. By default, a hyphen (-) is used.

\e field-
argument

The text in this switch’s field-argument specifies a sequence of characters that is used to separate an index entry and its first page number. By default, a comma (,) and space sequence is used. If text contains a horizontal tab character, the page number list is right justified in the column.

\f field-
argument

Builds an index using only those entries having the entry type (17.16.5.72) specified by text in this switch’s field-argument. Without this switch, all entries included.

\g field-
argument

The text in this switch’s field-argument specifies a sequence of characters that is used to separate the start and end of a page range. By default, an en dash is used.

\h field-
argument

Builds an index such that the text in this switch’s field-argument occurs as a heading— formatted with the Index Heading style—at the start of each set of entries for any given letter. If the first letter in text is A or a, that letter is replaced with the corresponding letter for each letter set. To replace the default heading with a blank line, use a space as text. [Example: INDEX \h “a Entries Follow” \c “1” \z “1033”

F Entries Follow fox, 1 Q Entries Follow quick brown fox. See Fox

end example]

\k field-
argument

The text in this switch’s field-argument specifies a sequence of characters that is used to separate an index entry and its cross reference (as produced by an XE entry (17.16.5.72)

\l field-
argument
\p field-
argument
\r
\s field-
argument
\y
\z field-
argument

having a \t switch). By default, a period (.) and space sequence is used. [Example: The quick brown fox{ XE “fox” } jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox{ XE “quick brown fox” \t “See Fox” } jumps over the lazy dog. The quick brown fox jumps over the lazy dog.

INDEX \k \c “1” \z “1033”

fox, 1 quick brown fox See Fox

end example]

The text in this switch’s field-argument specifies a sequence of characters that is used to separate two page numbers in a page number list. By default, a comma (,) and space sequence is used.

Builds an index using only those entries whose first letter is in the range of letters specified by text in this switch’s field-argument. The letter range has the form startLetter-endLetter. If startLetter is !, entries whose first character is not a letter, are also included, as are the letters starting from A. The letters in the range can be either upper- or lowercase.

Runs subentries into the same line as the main entry. Colons (:) separate main entries from subentries; semicolons (;) separate subentries.

The text in this switch’s field-argument is used as a sequence name, and the sequence number is included along with the page number, these numbers being separated by a hyphen (-), by default. Use the \d switch to specify a separator character other than the default.

Enables the use of yomi text for index entries.

The text in this switch’s field-argument specifies the language ID used to generate the index. This language ID is specified in the format defined by ST_Lang (22.9.2.6)

[Example: The index produced using the corresponding set of index entries and the field INDEX \e “tab” \g " to " \h “A” \z “1033” is:

B

behavior

implementation-defined ……………………………………. 2

I

documenting …………………………………….….…….. 3

item

package-relationship ………… See package-relationship item

O

Office Open XML ……………………………………… 2, 3, 4

X

XML …………………………………………………….… 1 to 4

end example]

Syntax: