16.5.4 Treating commas as potential index level separators

By default, DITA2Go treats commas in DITA index terms as potential level separators for indexes. However, DITA2Go breaks an index entry at a comma (or at any other level separator) only when there is at least one more entry that is an exact match up to the comma.

You can direct DITA2Go not to treat commas in index entries as level separators. The method depends on which type of Help system you are generating:

HTML-based Help

WinHelp

HTML-based Help

To prevent use of commas as index level separators in HTML-based help:

[Index]
; UseCommaAsSeparator = Yes (default) or No (never break at comma)
UseCommaAsSeparator=No

When UseCommaAsSeparator=Yes, DITA2Go breaks an index entry either at a comma or at an unescaped colon to add another level, but only if the text of two or more such index entries match up to the comma or colon.

When UseCommaAsSeparator=No, DITA2Go does not break any index entry at a comma. Index entries are broken only at unescaped colons, and only when two or more entries match up to a colon; but also see §16.5.5 Combining index levels for HTML-based Help and §16.5.6.2 Specifying level breaks for See and See also index entries.

WinHelp

To prevent use of commas as index level separators in WinHelp:

[HelpOptions]
; IdxColon = No (default, allow colon and comma as level delimiters)
;  or Yes (use only colon as delimiter, treat comma as regular text)
IdxColon=Yes

See §17.11.1 Designating index level separators.

Previous Topic:  16.5.3 Limiting length of index entries for HTML Help or WinHelp

Next Topic:  16.5.5 Combining index levels for HTML-based Help

Parent Topic:  16.5 Configuring index entries for Help systems

Sibling Topics:

16.5.1 Understanding how DITA2Go creates Help index entries

16.5.2 Preparing index entries for Microsoft Help Viewer

16.5.3 Limiting length of index entries for HTML Help or WinHelp

16.5.5 Combining index levels for HTML-based Help

16.5.6 Configuring See and See also entries for HTML-based Help

16.5.7 Specifying index link destinations for HTML-based Help

16.5.8 Customizing index sort order