#### 14.8.3 Configuring see and see-also index entries

To determine how see and see-also entries are displayed in the index, you can specify:

Format component names

Component building blocks

Text for redirection entries.

Format component names

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 = format to use at start of index-see-also
IndexSeeAlsoStart = SeeAlsoStartIndex
; IndexSeeEnd = format to use at end of index-see
IndexSeeEnd = SeeEndIndex
; IndexSeeAlsoEnd = format to use at end of index-see-also
IndexSeeAlsoEnd = SeeAlsoEndIndex

All values here are the default format names. If you change any format names, you must either alias your names to the default names, or provide your own definitions in a subformat configuration file.

Component building blocks

You can use the building blocks described in §8.1.5 Including typographic tags and character formats to fine-tune index see and see-also entries:

[SeeStartIndex]
help = Start of "see" index entry
form = <spc/><i><name/></i><spc/>

[SeeAlsoStartIndex]
help = Start of "see also" index entry
form = <i><name/></i><spc/>form = :<i><name/></i><spc/>

[SeeEndIndex]
help = End of "see" index entry
form =

[SeeAlsoEndIndex]
help = End of "see also" index entry
form =

These are the default formats, defined in Subformats configuration file d2htm_subformats.ini.

Text for redirection entries

To specify text for index see and see-also entries, in the language configuration file referenced by your project:

[IndexSeeText]
; SeeStartIndex = content to use at start of index-see entries
SeeStartIndex = see
; SeeAlsoStartIndex = content to use at start of index-see-also
SeeAlsoStartIndex = See also
; SeeEndIndex = content to use at end of index-see
SeeEndIndex =
; SeeAlsoEndIndex = content to use at end of index-see-also
SeeAlsoEndIndex =

Each value becomes the <name/> content of the corresponding format component. A colon at the end of the value specified for SeeEndIndex or SeeAlsoEndIndex forces the following item to the next index level.

Text for the settings in [IndexSeeText] is specified in language configuration files; see §8.9 Localizing output headings, labels, and names. The text shown here for these settings is the default text specified in d2g_lang_en.ini, located in directory %OMSYSHOME%\d2g\system\lang.

Previous Topic: 14.8.2 Overriding formats for index entries and references

Next Topic: 14.8.4 Configuring index references

Parent Topic: 14.8 Producing an index

Sibling Topics:

14.8.1 Specifying output formats for the index

14.8.2 Overriding formats for index entries and references

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 Contents • Index