Creating a Table of Contents

An auto-generated TOC will be structured as follows:

• The order of the TOC will be determined by the order of the documents in the Documents window pane.
• Heading 1 styles with no Heading 2 styles under them will appear at the main level
• Heading 1 styles with Heading 2 styles under them will appear at the main level as "books," with the Heading 2 styles indented below them.
• If used, Heading 3 styles will be indented under Heading 2 styles; Heading 4 styles under Heading 3 styles.
• If a Heading 1 style has no Heading 2 styles under it, it will not appear as a book in the TOC. It can be changed to one, but when the project is built it will not retain the book icon, because there are no subtopics under it.

The book icon visually indicates that "more information is available" about a topic.

By default, Heading styles 1-4 will be included in an auto-generated TOC. If you would like to add a Heading style to the TOC, open the Project Styles dialog and clear the Explicit access check box for that paragraph style. See About Project Styles and Topic Types.

You can see which topics are included in your TOC by opening the Topics window and looking at the TOC column.

Note: You can also view the topics in your TOC when you are working in Word by opening the Doc-To-Help Project Panel (Doc-To-Help>Project Panel), and selecting the Contents window pane. If you are working with a target-specific TOC, select the target from the drop-down at the top of the panel to see the topics in a specific target. See Contents Window Pane (Word).

Note: If your TOC is auto-generated, and you add a new topic to your project, that topic will automatically be added to the TOC the next time a target is built.

1. In Doc-To-Help, open the Contents window pane.

2. Add, delete, reorder, and rename TOC items as you wish.

   • Add a Topic to the TOC Drag it from the Topics window into the Contents pane.

   • Move a TOC Item Up or Down Choose it in the Contents pane and click the Move Up or Move Down buttons .

   • Change the Level of a TOC Item Choose it in the Contents pane and click the Move Out or Move In buttons .

   • Create a New, Empty Book Choose a spot in the Contents pane and click the Create Book button .

   • Convert a TOC Item to a Book (Must Have Subtopics) Choose it in the Contents pane, right-click, and choose Convert Topic to Book.

   • Rename a TOC Item Choose it in the Contents pane and click the Rename Topic button .

   • Delete a TOC Item Choose it in the Contents pane and click the Remove Topic button .

As soon as you manually edit the TOC, it will be flagged as "Customized." If you would like this TOC to be exclusively used for the target selected, click the Target-Specific Table of Contents button.

Once you have customized a TOC, any topics added to your project must be added manually, unless in the Project Settings dialog the Update customized table of contents in build check box is selected. Choosing this option will automatically add newly-created topics to your customized TOC when your project is built, although you will want to open the Contents window pane and confirm their location. To view the new topics added after a build, open the Doc-To-Help Topics ribbon, click the Filter View button, and choose Show only topics added in the last build. If you have deleted any topics, those will need to be deleted manually from the TOC. Target-specific TOCs will not be updated.

Note: In a Manual target, topics in multi-topic documents will always appear in the TOC in the same order as they appear in the source document. If the order is changed in the TOC, Doc-To-Help lists an error in the build log and does not use the customization.

1. In the Home ribbon, click the Select Target button and choose the desired target.
2. In Doc-To-Help, open the Contents window pane.
3. Manually edit the TOC.
4. Click the Target-Specific Table of Contents button .

Continue choosing targets to customize each one.

1. In the Home ribbon, click the Select Target button and choose the desired target.
2. Open the Contents window pane.
3. Click the Rebuild Table of Contents button .