Modular TOC Utility

One issue with modular HTML Help is that the child projects do not contain the entire table of contents (TOC). Generally, this limitation is not a problem because the hub Help file has the full table of contents and, in most cases, this is the Help file that is exposed to the end-user. Where the incomplete TOC can become an issue is during the use of context-sensitive Help. In this case, the child Help file may be called, leaving the end-user with no way to navigate through the entire Help contents. 

The Modular TOC Utility removes the TOC limitation by automatically adding the full TOC to each Help file in the modular project. The Modular TOC Utility is a stand-alone tool that can be used on any set of modular Help files. By simply pointing the utility at each of the component .hhp files, a fully functional TOC is incorporated into each modular Help file.

Verify that you have a fully defined modular Help system before continuing with the following steps.

  1. Open the Modular TOC Utility by selecting Start > All Programs > MadCap Software > Doc-To-Help > Modular TOC Utility. The Modular TOC Utility opens.
  2. Select Create a new Modular TOC file and click Next.
  3. After reading the dialog regarding the location of the new Modular TOC file, click OK.

  4. Browse to the directory where you want to store your .hub file. (You may want to use your Redistributables folder for this file. See Modular Projects.)

    Note The Modular TOC Utility will overwrite duplicate .hub files.

  5. Provide the Modular TOC Utility with a name for your .hub file and click Save.
  6. The Modular TOC Utility prompts you for the hub .hhp file. Browse and select the file, then click Open. (This file is located by default in the HTMLHelp sub-directory of your hub Help file.)
  7. The Modular TOC Utility lists all the child .hhp files in your modular Help system. Choose the first child .hhp file, then click Next.
  8. Choose the location of the appropriate .hhp file and click Open. (This file is located by default in the HTMLHelp sub-directory of your child Help file.)
  9. Repeat until each of the child .hhp files has been located.
  10. Click Next. The Modular TOC Utility prompts you to verify that the path for the build project.
  11. Click Next.
  12. Browse to select a directory to store your new modular Help files.
  13. Click Next.
  14. Verify the .hub file and build paths.
  15. Click Finish to build the new modular Help files.
  16. After the files are built, the Modular TOC Utility Editor opens.
  17. Close the Modular TOC Utility Editor and examine the Help files in your build directory. Note that each Help file (hub and child) will include the entire TOC.