16.3.1 Modifying contents or index production for HTML-based Help

You can use a configuration setting to override the default production method for contents or index or both; however, usually there is little reason to change the default method. You can also omit production of contents or index.

See also:

§16.4 Configuring contents entries for Help systems

§16.5 Configuring index entries for Help systems

§18.9.1 Choosing how to generate HTML Help contents and index

§19.6 Choosing navigation features for OmniHelp

§20.4.4 Locating JavaHelp or Oracle Help contents and index files

§21.4.1 Choosing contents and index methods for Eclipse 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 or None

RefFileType values have the following effects:

Full  

DITA2Go creates final contents and index files directly, depending on the value of ListType.

None  

No 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.

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

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

Previous Topic:  16.3 Producing contents and index for Help systems

Next Topic:  16.3.2 Modifying contents or index production for WinHelp

Parent Topic:  16.3 Producing contents and index for Help systems

Sibling Topics:

16.3.2 Modifying contents or index production for WinHelp