14.7.1 Specifying basic index settings

DITA2Go generates an index by default when you convert a bookmap that includes an <indexlist> element.

To prevent index generation:

[Index]
; GenerateIDX = Yes (default, generate index) or No.
GenerateIDX = No

If your conversion is based on a bookmap that includes an <indexlist> element, when GenerateIDX=Yes, DITA2Go creates the following:

If your conversion is based on a ditamap instead of a bookmap, or if your bookmap lacks an <indexlist>, for HTML output you can still get an index with the following setting:

[Index]
; UseIndex = No (default) or Yes, generate index.
UseIndex = Yes

To specify a title for the index and an output format for the title:

[Index]
; IDXTitle = title text for index
IDXTitle = Index
; IDXTitleFormat = format for index title
IDXTitleFormat = IndexTitle

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.

To specify output formats for index see and see-also entries:

[IndexSeeFormats]
; IndexSeeStart = format to use at start of index-see references
IndexSeeStart = SeeStartIndex
; IndexSeeAlsoStart = content to use at start of index-see-also
IndexSeeAlsoStart = SeeAlsoStartIndex
; IndexSeeEnd = content to use at end of index-see
IndexSeeEnd = SeeEndIndex
; IndexSeeAlsoEnd = content to use at end of index-see-also
IndexSeeAlsoEnd = SeeAlsoEndIndex

All values here are the default format names, specified in configuration template d2g_config.ini, located in directory %OMSYSHOME%\d2g\config. If you change any format names, you must either alias your names to the default names, or provide your own definitions in a format configuration file; see §7. Configuring output formats.

To redefine any of the see or see-also formats, see §8.8 Configuring index see and see-also entries.

Previous Topic:  14.7 Generating an index

Next Topic:  14.7.2 Configuring index features for RTF output

Parent Topic:  14.7 Generating an index

Sibling Topics:

14.7.2 Configuring index features for RTF output

14.7.3 Configuring index features for HTML output