Differences

This shows you the differences between two versions of the page.

--- toc [2015-08-30 14:00] – 132.72.87.125
+++ toc [2023-09-25 01:42] (current) – Klap-in
@@ Line 1: / Line 1: @@
-===== =====
+====== Table of Contents (TOC) ======
-===== =====
-===== =====
+The table of contents shows a summary of the page by listing the section headlines in a neat little box usually at the top right corner of the content. This allows users to have a quick look at the page structure and quickly jump to the part of the page they want.
-===== =====
+The TOC is only shown if a minimum number of qualifying headlines are present on the page, for more information refer [[#configuration]] below.
+===== Tips =====
+==== Turning off TOC ====
+The TOC can be turned off on any single page using the [[wiki:syntax#control_macros|control macro]] **''%%~~NOTOC~~%%''**.
+To disable TOC's completely, throughout the wiki, set either [[config:maxtoclevel]] or [[config:tocminheads]] to 0
+====  Don't show page title in TOC ====
+The top page heading, often the page title, can be prevented from appearing in the TOC by setting [[config:toptoclevel]] to 2.
+===== Configuration =====
+Configuration settings exist to control which heading levels should appear in the TOC ([[config:toptoclevel]], [[config:maxtoclevel]]) and how many of those headings are required for a TOC to be shown on the page ([[config:tocminheads]]).
+  * [[config:toptoclevel]] -- set the highest level heading to appear in the TOC
+  * [[config:maxtoclevel]] -- set the lowest level heading to appear in the TOC
+  * [[config:tocminheads]] -- set the minimum number of qualifying headings required for a TOC to appear
+E.g in a wiki with the following settings:
+  * toptoclevel = 2, ie. ''====='' (in an html page this corresponds <h2>)
+  * maxtoclevel = 4, ie. ''==='' ( in an html page this corresponds to <h4>)
+  * tocminheads = 3
+A page will need to have at least three headlines of levels 2-4 to be shown with a TOC.
+===== Development =====
+  * See [[devel:templates]]