Writerside
 
Get Writerside

Table of contents

Last modified: 17 January 2025

The table of contents (TOC) represents the structure of an instance. It is defined in a tree file using the <toc-element> tags.

Your readers see the TOC rendered in the left part of the published help website and can use it to navigate the sections and topics. By default, every topic also has an in-page TOC that renders on the right side of a topic page and shows first-level chapter titles.

As an author, you can use the Writerside tool window to see everything included in the current instance, add, remove, and move topics around. The TOC uses various icons and fonts to distinguish different types of TOC elements.

Regular TOC elements, which directly reference a topic file, are displayed without any icons and in regular font. Hover over it to see the associated topic file name.

If you hide a TOC element, Writerside will display it in gray font. Writerside will build the associated topic with the instance, but readers will not be able to navigate to it from the TOC, only through search or a direct link.

The Writerside tool window uses the following icons for various TOC element types:

In the TOC, you see the topic titles as they will be published, not the topic file names or topic IDs. If necessary, you can specify a TOC-only title or an instance-specific title. If you need to change the topic title, right-click the topic in the TOC and select Edit Title.