14.8.1 Specifying output formats for the index

If your project includes more than one index, you can override the settings described here with equivalent settings specific to each index; see §14.9 Configuring variant booklist components. The values shown here are default values for all indexes.

To specify output formats for index title, entries, and TOC entry:

[Index]
; IDXFormat = default format for index entries
IDXFormat = Index1
; IDXTitleFormat = format for index title
IDXTitleFormat = IndexTitle
; IDXTOCFormat = format of TOC entry for index title
IDXTOCFormat = IndexTOC

DITA2Go uses the value of IDXFormat only if all of the following are true:

By default, DITA2Go writes the index title as a heading at the top of the index page. For HTML output only, you can omit this heading:

[Index]
; UseIndexHeading = Yes (default, put a title on the index) or No.
UseIndexHeading = No

When UseIndexHeading=Yes, the title appears at the top of the index page. To provide a different kind of title of your own devising, set UseIndexHeading=No and use [Inserts] keyword IndexTop to specify code or a macro to produce a title; see §14.8.6.4 Customizing and linking to the index file.

To specify the text of a title for the index, in the language configuration file referenced by your project:

[IndexText]
; IDXTitle = text of index title
IDXTitle = Index

DITA2Go uses the value of IDXTitle as the index title if the indexlist element does not contain a @navtitle, and also uses this value for references to the index from the TOC and from related-links lists.

Previous Topic:  14.8 Producing an index

Next Topic:  14.8.2 Overriding formats for index entries and references

Parent Topic:  14.8 Producing an index

Sibling Topics:

14.8.2 Overriding formats for index entries and references

14.8.3 Configuring see and see-also index entries

14.8.4 Configuring index references

14.8.5 Including heading letters in the index

14.8.6 Configuring index features for HTML output

Table of ContentsIndex