Omni Systems, Inc.

  

Mif2Go User's Guide, Version 55

  

Valid HTML 4.01!

 

Made with Mif2Go

7 Producing on-line Help > 7.5 Configuring index entries for Help systems > 7.5.5 Treating commas as potential index level separators


7.5.5 Treating commas as potential index level separators

By default, Mif2Go treats commas in FrameMaker index entries as potential level separators for indexes, even though commas serve only a grammatical function in a FrameMaker-generated index. However, Mif2Go 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 Mif2Go 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, Mif2Go 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, Mif2Go 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 §7.5.6 Combining index levels for HTML-based Help and §7.5.7.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 §8.12.1 Designating index level separators.



7 Producing on-line Help > 7.5 Configuring index entries for Help systems > 7.5.5 Treating commas as potential index level separators