### 19.6 Choosing navigation features for OmniHelp

You can choose which navigation features to provide in OmniHelp; the default is to include them all:

    [OmniHelpOptions]
    ; NavElems = navigation elements to display in left pane:
    ;  Toc, Idx, Fts, Rel
    NavElems=Toc Idx Fts Rel

Table 19-3 lists the navigation features; all are displayed in the left-hand frame:

Table 19-3 OmniHelp navigation features

Feature | NavElems value | Reference
Contents |
    Toc
| §16.4 Configuring contents entries for Help systems §19.7 Configuring contents and index for OmniHelp
Index |
    Idx
| §16.5 Configuring index entries for Help systems §19.7 Configuring contents and index for OmniHelp
Full-text search |
    Fts
| §19.10 Configuring full-text search for OmniHelp
Related topics |
    Rel
| §19.8 Providing related-topic links in OmniHelp

If you do not intend to include an index, omit the Idx item:

    [OmniHelpOptions]
    NavElems= Toc Fts Rel

If you do not have ALinks, omit the Rel item also.

You can choose whether DITA2Go generates the data files needed for contents, index, search, and related topics; however, most likely you will never have a reason to change the default settings:

    [OmniHelpOptions]
    ; ListType = Both (default), Contents, or Index
    ListType = Both
    ; RefFileType = Full (default for single files), or None.
    RefFileType=Full

RefFileType values have the following effects:

Full | Default for single files. DITA2Go creates a set of myproj.oh* files for the original DITA file.
None | No myproj.oh* files nor DCL .bh* files are produced.

See also:

§16.3.1 Modifying contents or index production for HTML-based Help.

§19.7 Configuring contents and index for OmniHelp

Previous Topic: 19.5.7 Modifying the OmniHelp template

Next Topic: 19.7 Configuring contents and index for OmniHelp

Parent Topic: 19. Generating OmniHelp

Sibling Topics:

19.1 Understanding how OmniHelp works

19.2 Setting up OmniHelp viewer control files

19.3 Setting up an OmniHelp project

19.4 Using CSS with OmniHelp

19.5 Customizing OmniHelp display features

19.7 Configuring contents and index for OmniHelp

19.8 Providing related-topic links in OmniHelp

19.9 Jumping to secondary windows in OmniHelp

19.10 Configuring full-text search for OmniHelp

19.11 Setting up CSH for OmniHelp

19.12 Merging OmniHelp projects

19.13 Assembling OmniHelp files for viewing

19.14 Deploying OmniHelp

Table of Contents • Index