Adding an Automatic Table of Contents

You can insert a Microsoft Word doclet with a table of contents in Word and PDF-based report packages. For Word-based report packages, you can choose either a manual, automatic, or custom type. For manual types, you create page number links by using links and cross-references (see Inserting Links and Cross-References to Pages in Doclets. For automatic or custom types, the table of contents is updated whenever the doclet is merged into the report package. For example, do one of the following actions to merge the doclet and view the dynamically updated table of contents:

  • Preview the report package or section

  • Create a review instance

  • Create a sign off instance

  • Publish the report package

For PDF-based report packages, you must upload a Word doclet with an automatic table of contents. The system will automatically update the table of contents table and convert the Word document to PDF. See Adding Doclets.

Note:

The PDF-based table of contents is based on the report package hierarchy, not the headings in the Word document.

Tip:

When previewing only the doclet that contains the automated table of contents, the system will populate the table as follows: For Word-based report packages, the table is populated based on only the content within the doclet. This could result in an empty table. For PDF-based report packages, the table is populated based on the user’s access to doclets and sections within the report package. You must perform an action that merges the doclet into the report package or section to see the updated table of contents.