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.9 Customizing index sort order > 7.5.9.1 Listing characters to ignore in index sort order


7.5.9.1 Listing characters to ignore in index sort order

To specify which characters Mif2Go should ignore when ordering index entries for HTML Help or OmniHelp, use one or both of the following settings:

[Index]

; IgnoreCharsIX = characters to exclude when sorting index entries

; (en dash, em dash, and nonbreaking hyphen are all converted to

; hyphens first)

IgnoreCharsIX=-[]()<>_

; IgnoreLeadingCharsIX = characters to exclude if at the beginning of

; the entry when sorting index entries; multiples like $$ or .. are

; all excluded

IgnoreLeadingCharsIX=.$

By default, when sorting index entries Mif2Go ignores the following characters:

anywhere in an entry:

-   hyphen, nonbreaking hyphen, en dash, em dash

[ ] left and right square brackets

( ) left and right parentheses

< > left and right angle brackets

_   underscore.

as the leading character(s) in an indexed term:

. period(s)

$ dollar sign(s).

If you do not include any settings for IgnoreCharsIX or IgnoreLeadingCharsIX, Mif2Go uses these defaults. Characters specified for IgnoreCharsIX affect the sorting of sublevels; those specified for IgnoreLeadingCharsIX do not.

Suppose you provide no setting at all for IgnoreCharsIX, and just specify this setting:

[Index]

IgnoreLeadingCharsIX=?

In this case all of the following characters would be ignored for index sorting:

any number of ? at the beginning of any indexed term

any number of -, [, ], (, ), <, >, or _ anywhere in any entry.

To have only leading question marks ignored, you would specify:

[Index]

IgnoreCharsIX=

IgnoreLeadingCharsIX=?

To exclude all characters from the “ignore” sets, so all index entries that start with punctuation appear at the beginning of the Help index:

[Index]

IgnoreCharsIX=

IgnoreLeadingCharsIX=



7 Producing on-line Help > 7.5 Configuring index entries for Help systems > 7.5.9 Customizing index sort order > 7.5.9.1 Listing characters to ignore in index sort order