Table of contents
Each page can display a table of contents. This table of contents displays links to the headings in the page, thereby providing easy navigation for the user. The links are organized hierarchically, i.e. 3rd level headings are nested inside their respective 2nd level headers, etc.
The table of contents in a page is controlled via 3 general settings, which apply to all pages in the wiki:
- enable/disable TOC
- minimum heading depth to trigger TOC
- maximum heading depth
In addition, in each individual page, you can disable the TOC for that page by using the %%~~NOTOC~~%% tag anywhere in the page.
Enabling or disabling the TOC
This setting applies to all pages in the wiki.
If theTOC feature is disabled, then no page will display a TOC, irrespective of the value of the other settings. In this case, the TOC cannot be turned on for any page.
If the TOC feature is enabled, all pages may display a TOC, based on the conditions determined by the other settings described below. The %%~~NOTOC~~%% tag in an individual page will turn off the TOC display for that page.
Minimum heading depth to trigger display of TOC
This setting determines whether a given page will display a TOC, based on the levels of the page's headings. If a page has no heading of the level set by this parameter, no TOC will be displayed. On the other hand, if at least of heading of that level is found, then the TOC will be displayed.
For example, if set to 3, then only pages that have at least a level 3 heading will display a TOC. Pages that have only headings of level 1 or 2 will not display a TOC.
The purpose of this setting is to avoid displaying a TOC in simple pages with little depth, where such a TOC would add little value and clutter up the screen.
Maximum heading depth to display in TOC
This setting determines what the TOC should display. The value of the setting defines the heading level up to which headings will be displayed in the TOC. headings of a level higher than this value will not be displayed.
For example, if set to 4, all headings in the page up to level 4 will be displayed in the TOC. headings of level 5 and above will not be displayed.
This setting is independent from the minimum TOC level setting discussed in the previous section.
Disable TOC on an individual page
You can disable the TOC in a given page by including this tag %%~~NOTOC~~%%.
This page was modified on 4 Nov 2015 at 8:10 PM.
Source
====== Table of contents ======
Each page can display a table of contents. This table of contents displays links to the headings in the page, thereby providing easy navigation for the user. The links are organized hierarchically, i.e. 3rd level headings are nested inside their respective 2nd level headers, etc.
The table of contents in a page is controlled via 3 general settings, which apply to all pages in the wiki:
* enable/disable TOC
* minimum heading depth to trigger TOC
* maximum heading depth
In addition, in each individual page, you can disable the TOC for that page by using the ''%%~~NOTOC~~%%'' tag anywhere in the page.
===== Enabling or disabling the TOC ======
This setting applies to all pages in the wiki.
If theTOC feature is disabled, then no page will display a TOC, irrespective of the value of the other settings. In this case, the TOC cannot be turned on for any page.
If the TOC feature is enabled, all pages may display a TOC, based on the conditions determined by the other settings described below. The ''%%~~NOTOC~~%%'' tag in an individual page will turn off the TOC display for that page.
===== Minimum heading depth to trigger display of TOC =====
This setting determines whether a given page will display a TOC, based on the levels of the page's headings. If a page has no heading of the level set by this parameter, no TOC will be displayed. On the other hand, if at least of heading of that level is found, then the TOC will be displayed.
For example, if set to 3, then only pages that have at least a level 3 heading will display a TOC. Pages that have only headings of level 1 or 2 will not display a TOC.
The purpose of this setting is to avoid displaying a TOC in simple pages with little depth, where such a TOC would add little value and clutter up the screen.
===== Maximum heading depth to display in TOC =====
This setting determines what the TOC should display. The value of the setting defines the heading level up to which headings will be displayed in the TOC. headings of a level higher than this value will not be displayed.
For example, if set to 4, all headings in the page up to level 4 will be displayed in the TOC. headings of level 5 and above will not be displayed.
This setting is independent from the **minimum TOC level** setting discussed in the previous section.
===== Disable TOC on an individual page =====
You can disable the TOC in a given page by including this tag ''%%~~NOTOC~~%%''.