Omni Systems, Inc. Mif2Go User's Guide, Version 55

<< Prev | Next >>

> 11 Generating JavaHelp or Oracle Help > 11.4 Generating contents and index > 11.4.3 Configuring index entries for JavaHelp or Oracle Help

### 11.4.3 Configuring index entries for JavaHelp or Oracle Help

Mif2Go generates the JavaHelp or Oracle Help index file, MyDoc Index.xml. However, most of the ways you can customize index entries for HTML-based help, described in §7.5 Configuring index entries for Help systems, do not work for either JavaHelp or Oracle Help. Both produce indexes with the following possibly undesirable display features:

• Index entries are not formatted; any character formatting is lost.

• Sort-order settings from the Mif2Go configuration file are ignored, even though they correctly inform the order of items in MyDoc Index.xml.

JavaHelp

In JavaHelp there is no graceful way to handle index entries that have multiple references to different places in the helpset, so Mif2Go converts multiple references into subentries, each with the topic title (including any autonumber) as the visible information.

Oracle Help for Java

Oracle Help supports only two levels of index entries; the index view collapses any levels beyond the second.

Oracle Help provides an <iindexentry> tag for index files, which affects how topic names display for multiple references to the same index term. You can turn it off:

[JavaHelpOptions] or [OracleHelpOptions]

; UseIndexentryTag = Yes (OracleHelp only, default)

; or No (as in Sun JavaHelp)

UseIndexentryTag = No

You should not need to change the default setting for UseIndexentryTag, unless you are generating Oracle Help for Java and you prefer the way Mif2Go handles multiple-reference index entries for JavaHelp.

See §7.5 Configuring index entries for Help systems.