#### 18.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 §18.3.8 Regenerating the HTML Help project file.

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

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

Table 18-2 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 §18.4.2 Adding tabs and toolbar buttons to HTML Help.
Supports no-link entries in the TOC; see §18.9.5 Configuring contents entries for HTML Help.
Allows the TOC to stay synchronized with topics selected via the index; see §18.9.7 Making the TOC track index links in HTML Help.
Cons: | Incompatible with merging .chm files at run time; see §18.14.5 Comparing HHW settings for stand-alone vs. merged CHMs.
Can cause problems with mid-topic TOC links; see §18.9.6 Providing mid-topic contents links in HTML Help.
Index | Pros: | Supports merging .chm files at run time; see §18.14.5 Comparing HHW settings for stand-alone vs. merged CHMs.
Cons: | Prevents index customization; see §16.5.8 Customizing index sort order.

Previous Topic: 18.9.1 Choosing how to generate HTML Help contents and index

Next Topic: 18.9.3 Generating contents and index with HTML Help Workshop

Parent Topic: 18.9 Generating contents and index for HTML Help

Sibling Topics:

18.9.1 Choosing how to generate HTML Help contents and index

18.9.3 Generating contents and index with HTML Help Workshop

18.9.4 Generating contents and index with DITA2Go

18.9.5 Configuring contents entries for HTML Help

18.9.6 Providing mid-topic contents links in HTML Help

18.9.7 Making the TOC track index links in HTML Help

18.9.8 Customizing contents and index for HTML Help

Table of Contents • Index