Adding a Table of Contents makes it easy for users to navigate between sections in your template. When the template is used to create documents, then it will make it easy for users to navigate between those same sections too.
If you create a template version by uploading a document or importing a Google Doc, any existing table of contents will need to be removed and replaced with our Table of Contents element. This makes it so we can dynamically update the table of contents based on the headers you use.
This is what the Table of Contents element looks like in the template editor:
How to Insert a Table of Contents into a Template
To insert the Table of Contents element into a template using the Template Editor, follow these steps:
1. From the top navigation in the Template Editor, select Insert Smart Elements.
2. Click the link for Table of Contents.
3. The Table of Contents will be inserted into the document where you cursor was located in the template.
4. The only customization for the Table of Contents element is to force it to refresh.
Note: The green highlight around the element shows that it is selected for editing. The green highlight only displayed in the Template Editor and not in associated documents.
How the Table of Contents is Populated
The Table of Contents is dynamically created and updated using the headers in the template. Heading 1 are the top level items, followed by Heading 2, then Heading 3 etc.
- Heading 1
- Heading 2
- Heading 3
- Heading 2
- Heading 1
When a the title of a section does is not formatted as a header, then it will not be included in the Table of Contents. In this example, the procedure has section for Scope and Safety Requirements. These two sections are not being included in the Table of Contents yet because they are not headers.
You can format a title to be a header using the text formatting toolbar.
Click on the More Paragraph button to get additional formatting options.
Then locate the option for Paragraph Format. This will allow you to change the format to be a heading.
When you have the text selected that you want to convert to be formatted as a header, select on of the heading options.
The title will then be formatted based on the select heading type. Then it can be included dynamically in the Table of Contents.
You can continue to format the titles of your sections as various heading types. The additional heading will then be included in the Table of Contents dynamically.
How to Refresh the Table of Contents
The Table of Contents will be refreshed when make changes. If for some reason you have change the text for a current header or added a new header and those changes are not reflected in the Table of Contents, you can force it to refresh.
Open the options for the Table of Contents element by clicking on it. This will bring up the edit options in the right toolbar. Then click the Refresh button.