Omni Systems, Inc.

  

Mif2Go User's Guide, Version 55

  

Valid HTML 4.01!

 

Made with Mif2Go

9 Generating Microsoft HTML Help > 9.9 Generating contents and index for HTML Help > 9.9.2 Choosing whether to generate binary contents or index


9.9.2 Choosing whether to generate binary contents or index

To produce binary TOC and index for HTML Help:

[MSHtmlHelpOptions]

; BinaryTOC = No (default) or Yes (required for native browse)

BinaryTOC = Yes

; BinaryIndex = No (default) or Yes (required to merge .chm files)

BinaryIndex = Yes

These settings take effect only when WriteHelpProjectFile=Yes; see §9.3.9 Regenerating the HTML Help project file.

Alternatively, you can specify binary TOC or index generation directly in the .hpj file, under [Options]; see §9.4.3 Adding tabs and toolbar buttons to HTML Help.

There are trade-offs to generating binary navigation features for HTML Help. Table 9-3 lists the pros and cons of specifying a binary TOC or a binary index.

Table 9-3 Binary TOC/Index advantages and disadvantages for HTML Help

Binary feature

Advantages and disadvantages

TOC

Pros:

Supports browse via Prev and Next buttons in the HTML Help viewer; see §9.4.3 Adding tabs and toolbar buttons to HTML Help.

Supports no-link entries in the TOC; see §9.9.5 Configuring contents entries for HTML Help.

Allows the TOC to stay synchronized with topics selected via the index; see §9.9.7 Making the TOC track index links in HTML Help.

Cons:

Incompatible with merging .chm files at run time; see §9.15.5 Comparing HHW settings for stand-alone vs. merged CHMs.

Can cause problems with mid-topic TOC links; see §9.9.6 Providing mid-topic contents links in HTML Help.

Index

Pros:

Supports merging .chm files at run time; see §9.15.5 Comparing HHW settings for stand-alone vs. merged CHMs.

Cons:

Prevents index customization; see §7.5.9 Customizing index sort order.



9 Generating Microsoft HTML Help > 9.9 Generating contents and index for HTML Help > 9.9.2 Choosing whether to generate binary contents or index