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

<<  Prev

Next  >>

> 7 Producing on-line Help > 7.3 Producing contents and index for Help systems > 7.3.4 Modifying contents or index production for HTML-based Help > 7.3.4.1 Choosing contents and index methods for HTML-based Help

7.3.4.1 Choosing contents and index methods for HTML-based Help

To specify whether contents, index, or both should be generated for HTML-based Help:

[MSHtmlHelpOptions] or

[OmniHelpOptions] or

[JavaHelpOptions] or

[OracleHelpOptions]

; ListType (for filter to create) = Both (default), Contents, or Index

To specify how contents and/or index should be generated for HTML-based Help, depending on the value of ListType:

[MSHtmlHelpOptions] or

[OmniHelpOptions] or

[JavaHelpOptions] or

[OracleHelpOptions]

; RefFileType = Full, Body, or None

RefFileType values have the following effects:

[spacer]

Body

Default for books. Mif2Go creates the following:

  • MyDoc.lst, if you are converting a book
  • Chapter.bhc for each chapter (if ListType=Contents or Both)
  • Chapter.bhk for each chapter (if ListType=Index or Both).

If you are converting a book, or if you are converting a chapter and the book file is open in FrameMaker, Mif2Go merges files to create the following:

  • a combined contents file from all .bhc files (if ListType=Contents or Both)
  • a combined index file from all .bhk files (if ListType=Index or Both).

Full  

Default for single-file documents. Mif2Go creates final contents and index files directly, depending on the value of ListType.

None  

No list, contents, or index files are produced.

You might set RefFileType=None if you are repeatedly re-running a conversion to tune something in text, and you do not want the (small) overhead of writing out the contents and index information every time.

Note:   If you set RefFileType=Full when you are converting a FrameMaker book, you will get contents and index entries only for the last chapter file in the book.

HTML Help

For HTML Help, you can specify one additional value for RefFileType. See §9.9.1 Choosing how to generate HTML Help contents and index.

OmniHelp

For OmniHelp, whether contents and index are displayed (as opposed to generated) is determined by another setting; see §10.6 Choosing navigation features for OmniHelp

Eclipse Help

For Eclipse Help, the default value of RefFileType is Full, regardless of whether you are converting a FrameMaker book or a single-file document. See §12.4.1 Choosing contents and index methods for Eclipse Help.