Table of contents for a page

Warning

Dynamic blocks are fully compatible with dynamic tables and any pages created in the legacy editor.

Creating new pages in the legacy editor is no longer possible.

However, you can easily convert any existing pages from the legacy editor to the new editor format. For more information, see Switching a page to the new editor format.

Wiki pages created in the old editor may automatically generate a table of contents based on headings. This is done using a dynamic block named toc.

Adding a table of contents for a page

  1. Make sure your page is created in the old editor.

  2. Make sure the page headings are marked up properly.
    If there are matching headings on the page, the links in the table of contents may not work correctly.

  3. Add the {{toc}} dynamic block to the page.

By default, all headings of the current Wiki page are added to the table of contents. You can configure the additional TOC settings using the advanced parameters.

Here is an example of a table of contents that includes first (h1) to third (h3) level headings:

{{toc from="h1" to="h3"}}

Block parameters (optional)

Parameter Description
from Highest level of headings to include first in the table of contents
to Lowest level of headings to include last in the table of contents
page Relative address of the table of contents source page, e.g., userName/pageName/; default address of the page where the toc block is added

Adding a table of contents for a page group

There are two ways to add a table of contents:

  1. Following this guide.

  2. Using links:

    ((<link> <page_name>))

    [<page_name>](<link>)
Previous
Formulas, diagrams, and flowcharts
Next
Bookmarks on pages