Omni Systems, Inc.

  

Mif2Go User's Guide, Version 55

  

Valid HTML 4.01!

 

Made with Mif2Go

10 Generating OmniHelp > 10.6 Choosing navigation features for OmniHelp


10.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 10-4 lists the navigation features; all are displayed in the left-hand frame:

Table 10-4 OmniHelp navigation features

Feature

NavElems value

Reference

Contents

Toc

§7.4 Configuring contents entries for Help systems

§10.7 Configuring contents and index for OmniHelp

Index

Idx

§7.5 Configuring index entries for Help systems

§10.7 Configuring contents and index for OmniHelp

Full-text search

Fts

§10.10 Configuring full-text search for OmniHelp

Related topics

Rel

§10.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 Mif2Go 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),

;  Body (default for books), or None.

RefFileType=Full

RefFileType values have the following effects:

[spacer]

Full

Default for single files. Mif2Go creates a set of myproj.oh* files for the original FrameMaker file.

Body

Default for books. Mif2Go creates a set of DCL .bh* files that are merged with those from other chapter files to produce a combined set of myproj.oh* files for the book.

None

No myproj.oh* files nor DCL .bh* files are produced.

See also:

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

§10.7 Configuring contents and index for OmniHelp



10 Generating OmniHelp > 10.6 Choosing navigation features for OmniHelp