data/TWiki/VarTOC2.txt
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
permissions -rw-r--r--
RELEASE 4.2.0 freetown
     1 %META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.1" version="2"}%
     2 %META:TOPICPARENT{name="TWikiVariables"}%
     3 #VarTOC2
     4 ---+++ TOC{"Topic"} -- table of contents
     5    * Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax (="---++ text"=) and HTML (="&lt;h2&gt;text&lt;/h2&gt;"=) are taken into account. Any heading text after ="!!"= is excluded from the TOC; for example, write ="---+!! text"= if you do not want to list a header in the TOC
     6    * Syntax: =%<nop>TOC{"SomeTopic" ...}%=
     7    * Supported parameters:
     8     | *Parameter:* | *Description:* | *Default:* |
     9     | ="TopicName"= | topic name | Current topic |
    10     | =web="Name"= | Name of web | Current web |
    11     | =depth="2"= | Limit depth of headings shown in TOC | 6 |
    12     | =title="Some text"= | Title to appear at top of TOC | none |
    13    * Example: =%<nop>TOC{depth="2"}%=
    14    * Example: =%<nop>TOC{"TWikiDocumentation" web="%SYSTEMWEB%" title="Contents:"}%=
    15    * Example: see TWiki:Sandbox.TestTopicInclude
    16    * %T% Hint: TOC will generate links to the headings, so when a reader clicks on a heading it will jump straight where that heading is anchored in the text. If you have two headings with exactly the same text, then their anchors will also be identical and they won't be able to jump to them. To make the anchors unique, you can add an invisible HTML comment to the text of the heading. This will be hidden in normal view, but will force the anchors to be different. For example, <tt>---+ Heading &lt;!--5--&gt;</tt>.
    17    * Related: [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarTOC][TOC]]
    18