Automatically Generating/Updating the Table of Contents

Overview

JHelpDev allows you to automatically generate a new Table of Contents or update an existing one.

  1. Be sure you Map is up to date by clicking "Create Map".
  2. Open the TOC Editor.
  3. Click "Generate TOC".
When the generation process is complete, all newly imported items will be highlighted in green and will be ready for draging into their real destination, renaming, and sorting. Additionally, any directories that contain newly added imported will be highlighted in green so you can easily find them.

Details and Limitations

Generate TOC searches the HTML files in the directory tree and attempts to generate a TOC title by looking at the the following tags in the given order <title> <h1> <h2> <h3> <h4> <h5>. If it does not find any of the tags in the file, it takes the filename as title for the TOC item. The directory structure is also represented but can easily be changed by moving the items around with the mouse.

If you already have a Table of Contents, clicking Generate TOC will not affect anything that's already in your TOC - it will only add new entries. In most cases, Generate TOC should do what you expect it to do, but it does have some limitations:

  • If files that were already in your TOC have been moved from one directory to another on your file system, Generate TOC will not move them around in your Table of Contents - that's left to you.
  • Files that are added to your TOC will be added inside a directory structure that exactly matches your file system. You may need to relocate the newly added entries and or delete directories if the default import doesn't work for you.

See also: Creating the Table of Contents