Detail | Answer |
Plan Availability | All plan types |
Permissions | General Access: Add, edit, and delete a Table of Contents in SmartDoc fields. |
Related Reading |
Overview
SmartDocs make it easy to organize complex content, but long documents can become challenging to navigate. The Table of Contents feature works seamlessly with SmartSuite Headings to:
Automatically generate a hierarchical list of sections.
Provide readers with a preview of the document structure.
Allow easy navigation to specific sections with a single click.
Why Use a Table of Contents?
Automatic Organization:
The Table of Contents generates a list of topics based on the headings in your SmartDoc, saving you time from creating one manually.
Improved Navigation:
Readers can quickly locate sections they’re interested in by clicking on the headings in the Table of Contents. Read more about Headings in this article
Ease of Maintenance:
Any updates to your SmartDoc headings are automatically reflected in the Table of Contents.
Working with Table of Contents
How It Works
The Table of Contents automatically displays all defined headings in your SmartDoc. It is also collapsible, so users can hide it when not needed. Headings are displayed hierarchically as follows:
H1 Headings: Displayed at the top level.
H2 Headings: Indented under H1 headings.
H3 Headings: Indented under H2 headings.
… and so on, through H6.
Adding Headings to Your SmartDoc
You can create headings in two ways:
Using the Formatting Toolbar:
Select the desired heading level from the toolbar.
Using Text Markdown:
Type
#followed by a space for an H1 heading.Type
##for an H2 heading,###for an H3 heading, and so on.
Once your content is structured with headings, you’re ready to add a Table of Contents.
Read all about Headings and many other types of SmartDoc formatting in this detailed article.
Adding a Table of Contents
To insert a Table of Contents:
Use the Slash Command:
Type
/at the start of a new line or after a space.Type "table of contents" or scroll to it in the Advanced section.
Click Table of Contents.
Placement:
The Table of Contents will appear where your cursor is located when you enter the slash command.
Collapsed View:
The Table of Contents is initially collapsed. Expand it by clicking on the bar.
Navigating the Table of Contents
Clickable Links:
All headings in the Table of Contents are clickable, allowing readers to jump directly to the corresponding section.
Automatic Updates:
The Table of Contents updates automatically to reflect changes to your SmartDoc headings.
Note: The Table of Contents is not configurable and will display text exactly as it appears in the headings.
Deleting a Table of Contents
If you no longer need a Table of Contents:
Place your cursor immediately after the Table of Contents.
Press the Backspace key to delete it.
Tip: To undo deletion, press Control-Z or re-add the Table of Contents using the slash command.
Practical Use Cases and Scenarios
1. Organizing Project Documentation
Scenario: A project manager creates a SmartDoc with multiple sections for project phases, requirements, and updates.
Solution: Add a Table of Contents to allow team members to navigate quickly to specific sections.
Outcome: Improved team efficiency and easier access to key project details.
2. Simplifying Training Manuals
Scenario: An HR manager builds a training manual in SmartDoc with chapters for policies, procedures, and FAQs.
Solution: Use the Table of Contents to structure the manual and make navigation simple for new hires.
Outcome: Enhanced user experience and better knowledge retention.
3. Enhancing Technical Documentation
Scenario: A developer writes detailed technical documentation with multiple nested sections.
Solution: Insert a Table of Contents to help readers locate topics quickly.
Outcome: Streamlined navigation for developers and technical staff.