Users with edit permissions can create and manage a Table of Contents within a report via the left sidebar page options or directly inside a Content or Note Page block. Typically configured during the report creation or during a final review, this feature helps navigate readers to specific information.
Select an option below to navigate directly to that section:
- Build a New Table of Contents
- Add a Report Section to a Table of Contents
- Add Specific Content to a Table of Contents
- Troubleshooting
- Frequently Asked Questions
Build a New Table of Contents Walkthrough
Select Next to move through the guide. You can also zoom in and out of the image by selecting the Magnifying Glass in the bottom right-hand corner. You can view the full guide by selecting the External Link icon.
Step-by-Step Instructions
- Within the report, select the Section after which you want to insert the new TOC.
- Select the Plus (+) icon to the right of the page name and select TOC.
- In the Entity field, enter your Organization’s name or add a Report Variable to insert your organization name and update with one click during the roll-forward process year over year.
-
Ensure the Fiscal period is accurate in the Full-fiscal-period field.
- We also recommend adding a Report Variable for your Fiscal Year to update with one click during the roll-forward process year over year.
-
In TOC Type, select the Master TOC layout you wish to use. Each template has its own layout:
- Main TOC is typically used for navigating the entire report.
- Notes TOC is typically used to help navigate notes within a report.
- Statistical TOC is typically used for navigating any statistical content in a report.
- Use the Title field to rename the Table of Contents as needed.
-
To change the number of columns for the Table of Contents, select the appropriate Column icon to the right of the TOC fields.
- Note: The Balanced Columns format is enabled by default, but you can select it to disable it.
-
Click Refresh to see your changes and a template of the Table of Content.
- Note: When clicking Refresh initially, you will only see a basic/unformatted version of the TOC without the final styling and page numbers. Once a full draft of the report is generated, the preview will show the fully formatted TOC with the correct page numbers.
After creating the table of contents, you may need to add report sections and specific content to the list.
- Add a Report Section when you want to add an entire report section to the Table of Contents. A report section may include multiple elements, such as text, tables, charts, or other information presented together. For example, a Note or MD&A section can be added as a complete section.
- Add Specific Content to the table of contents when you want to add specific information within a report section rather than the entire section.
Add a Report Section to a Table of Contents Walkthrough
Select Next to move through the guide. You can also zoom in and out of the image by selecting the Magnifying Glass in the bottom right-hand corner. You can view the full guide by selecting the External Link icon.
Step-by-Step Instructions
- To add a section to your Table of Contents, select the Options icon (three dots) of the page you wish to include and select Include in TOC.
- Toggle on Show in Table of Contents.
- Select the TOC type from the existing options.
-
Select the appropriate Level to place the section within the Table of Contents.
Note: The selected level determines its indentation and hierarchy in the Table of Contents.
- Add a display name for the Section within the Table of Contents in TOC Text.
- Click Save.
Note: Return back to your Table of Contents and click Refresh to see your changes, but remember, you will not be able to see a fully formatted TOC with accurate page numbers until after generating a full report for the first time.
Add Specific Content to a Table of Contents Walkthrough
Select Next to move through the guide. You can also zoom in and out of the image by selecting the Magnifying Glass in the bottom right-hand corner. You can view the full guide by selecting the External Link icon.
Step-by-Step Instructions
- Within a Content or Note page, you can show a specific content block (header, text, tables or images) in the Table of Contents. Toggle on Show in Table of Contents to begin.
-
Select the TOC type from the existing options.
- Main TOC is typically used for navigating the entire report.
- Notes TOC is typically used to help navigate notes within a report.
- Statistical TOC is typically used for navigating any statistical content in a report.
-
Select the Level of the Table of Contents to place it in.
Note: The selected level determines its indentation and hierarchy in the Table of Contents.
- Add the display name for the content block in the Table of Contents in TOC Text.
Note: Return back to your Table of Contents and click Refresh to see your changes, but remember, you will not be able to see a fully formatted TOC with accurate page numbers until after generating a full report for the first time.
Troubleshooting
Issue: Why am I not seeing the correct page numbers or formatting in the preview?
Solution: If you have not generated a PDF of the report yet, the preview will only show a basic and unformatted version of the Table of Contents. To preview this, we recommend generating a full copy of the report.
Frequently Asked Questions (FAQs)
Q: How is the order of the pages determined in the Table of Contents?
A: This is based on what report sections or content has been added to the table of contents and the order of the report sections and content blocks within a section. You can drag and drop the report sections on the left hand side of the report and move non-locked content blocks around within a section by hovering over the section and selecting either the up or down arrow. Link to article.
Q: What level should I select for a page or content block when adding to my Table of Contents?
A: The Level determines the hierarchy and organization of the Table of Contents. It shows how sections relate to one another and creates the appropriate indentation so the Table of Contents is structured rather than simply listing items.
Use different levels to indicate the relationship between main sections, subsections, and the content within those sections.
Tip: Typically we see Dividers as Section Levels and Content Pages as Level 1 and 2 with Notes and Content as Level 3, but this is completely up to you!
The easiest way to determine the levels is to look at a previous Table of Contents and reproduce the same structure. Section headings without page numbers define the Section Levels, and the indentation/formatting of the content underneath them tells you which level to select.
Note: A change in font style or formatting can also indicate that the hierarchy has changed.
Example of Levels in a Table of Contents
Q: Can I change the type of numbers (arabic, roman numeral, etc) shown in my Table of Contents?
A: Yes! We recommend changing Page Numbering settings of the first page within your Table of Contents. Anytime you need the type of numbering to change, head to the page where you want the change to occur and select the next type of page numbering. Link to article
Q: Do pages/report sections look different on a table of contents compared to content on a page?
A: In terms of aesthetics, no. However, based on the level you select, that is what will separate it from the rest of the table of content references. However, a change in font style or formatting can also indicate that the hierarchy has changed no matter what is being referenced.
Q: When should I add a page (report section) to the table of contents vs content?
Add Sections to a Table of Contents Use this option when you want to add an entire report section to the Table of Contents. A report section may include multiple pages and elements, such as text, tables, charts, or other information presented together. For example, a Note or MD&A section can be added as a complete section.
Add Content to a Table of Contents Use this option when you want to add specific information within a report section rather than the entire section. This could be a specific table, chart or statement for reference.
Q: What layout should I choose for my Table of Contents?
A: It will depend on what the table of contents is needed for - the entire report (main), statistical information or notes.
Note: Each report template has its own set of layouts and the theme will determine the aesthetics of the table of content.
Q: How can I review my Table of Contents and its page numbers?
A: Generating a report will allow you to see what sections and content is currently included in the table of contents, the page numbers and how the levels assigned are affecting the placement.
Have more questions or need assistance?
Submit a Request