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

DITA2Go generates the JavaHelp or Oracle Help index file, MyDocIndex.xml. However, most of the ways you can customize index entries for HTML-based help, described in §16.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 DITA2Go configuration file are ignored, even though they correctly inform the order of items in MyDocIndex.xml.

JavaHelp

In JavaHelp there is no graceful way to handle index entries that have multiple references to different places in the helpset, so DITA2Go 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 DITA2Go handles multiple-reference index entries for JavaHelp.

See §16.5 Configuring index entries for Help systems.

Previous Topic: 20.4.2 Assigning TOC images and expansion levels in JavaHelp 2

Next Topic: 20.4.4 Locating JavaHelp or Oracle Help contents and index files

Parent Topic: 20.4 Generating contents and index

Sibling Topics:

20.4.1 Configuring contents entries for JavaHelp or Oracle Help

20.4.2 Assigning TOC images and expansion levels in JavaHelp 2

20.4.4 Locating JavaHelp or Oracle Help contents and index files

Table of Contents • Index