Edit special text flow for a list or index

Learn how you can edit a special text flow for a list or index.

Many formatting aspects of a list or index are controlled by a special text flow on a reference page in the generated file. The name of the reference page matches the default suffix, such as TOC for a table of contents or IX for a standard index.

For generated lists, each paragraph in the flow corresponds to a paragraph style or marker type you included in the list. These paragraphs have styles that use the default suffix. For example, a paragraph with the style Heading1TOC in the text flow for a table of contents corresponds to the entries for first-level headings (tagged Heading1 in the source document).

Figure 1. Special text flow on reference page for a table of contents

For indexes, the paragraphs in the flow correspond to the marker types you included in the index, the levels of entries and subentries, the sort order, the separator text used, and several other index properties.

Figure 2. Special text flow for an index

Structureof the specialtext flow for an index

A. Separators placeholder B. Levels of entries C. Group titles placeholder D. Sort order E. Ignore characters placeholder

If the list or index was created with hypertext links, the special text flow also contains a paragraph that specifies the form of the hypertext commands in the generated file. The paragraph’s style name begins with the word Active.

Special text flows for lists and indexes have special paragraphs with placeholder text. This placeholder text lets you specify how your entries will look when you regenerate the file.

Building blocks placed in each paragraph of the special text flow determine the information that appears in the list or index, and the order in which the information appears. You can use the following building blocks in the special text flow.

Building block	Meaning
`<$autorange>`	Automatically creates index page ranges
`<$numerics>` `<$alphabetics>` `<$symbols>` `<$kana>`	Specifies the overall sort order in an index
`<$pagenum>`	Displays the page number on which the source paragraph or marker appears
`<$volnum>`	Displays the volume number of the document in which the source paragraph or marker appears
`<$chapnum>`	Displays the chapter number of the document in which the source paragraph or marker appears
`<$paratext>`	Displays the text of the paragraph, excluding any autonumber
`<$paranum>`	Displays the paragraph’s entire autonumber, excluding spaces and tabs at the end of the autonumber (for example, Section 2.1.1)
`<$paranumonly>`	Displays the paragraph’s autonumber counters and the characters between them (for example, 2.1.1)
`<$paratag>`	Displays the source paragraph’s style name

In the list or index, choose View > Reference Pages.
Display the reference page that contains the text flow you want.
Edit the appropriate paragraphs in the text flow.
Choose View > Body Pages.
Generate the index again to see the effect of your changes.

Note: Make sure that you generate the list or index from the source document, not from the generated file.