#### 18.9.8 Customizing contents and index for HTML Help

Two settings allow you to specify additional properties for contents and index:

    [MSHtmlHelpOptions]
    ; Properties for the .hhc and .hhk files; can contain macros.
    HHCProperties=<param name="ContentsParamName" value="ParamValue">
    HHKProperties=<param name="IndexParamName" value="ParamValue">

Each setting assigns a parameter for an HTML Help contents or index properties object. You can use DITA2Go macros to assign multiple parameters. For example:

    [MSHtmlHelpOptions]
    HHCProperties=<param name="ContentsParam" value="ContentsValue">
    HHKProperties=<$HHKPropMacro>

    [HHKPropMacro]
    <param name="IndexParam" value="IndexValue">
    <param name="OtherIndexParam" value="OtherIndexValue">

DITA2Go supplies the enclosing <object type="text/site properties"> tag.

Copy Workshop parameters

You can choose contents or index properties in HTML Help Workshop, then specify those same properties in the configuration file, so they will be applied every time you run the conversion. For example, to customize contents:

1. Use DITA2Go to convert your document to HTML Help.
2. Open the HTML Help project file (myproj.hhp) in HTML Help Workshop.
3. With the Contents tab selected, click the Properties icon.
4. Set whatever properties you wish in the Table of Contents dialog, then click OK.
5. Save the project, then exit HTML Help Workshop.
6. Open the HTML Help contents file (myproj.hhc) in a text editor such as Notepad, and find the properties object at the start of the body. For example:

       <!-- Sitemap 1.0 -->
       </HEAD><BODY>
       <OBJECT type="text/site properties">
               <param name="Window Styles" value="0x800425">
       </OBJECT>

7. If there is just one <param ...> tag, copy the tag and assign it as follows:

       [MSHtmlHelpOptions]
       HHCProperties=<param name="Window Styles" value="0x800425">

   If there is more than one <param ...> tag, use a macro; for example:

       [MSHtmlHelpOptions]
       HHCProperties=<$MyHHCProps>

       [MyHHCProps]
       <param name="Window Styles" value="0x800425">
       <param name="Background" value="0x808040">

See HTML Help Workshop Help for information about the properties you can specify.

See also:

§16.4 Configuring contents entries for Help systems

§16.5 Configuring index entries for Help systems

Previous Topic: 18.9.7 Making the TOC track index links in HTML Help

Next Topic: 18.10 Providing full-text search (FTS) for HTML Help

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.2 Choosing whether to generate binary contents or 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