VarTOC2 < TWiki

#VarTOC2
---+++ TOC{"Topic"} -- table of contents
%STARTSECTION{"summary"}%
   * 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. An abbreviated heading can be shown in the TOC, such as ="---++ text!! this is excluded from TOC"=.%ENDSECTION{"summary"}%
   * Syntax: =%<nop>TOC{"SomeTopic" ...}%=
   * Supported parameters:
    | *Parameter:* | *Description:* | *Default:* |
    | ="TopicName"= | Topic name | Current topic |
    | =web="Name"= | Name of web | Current web |
    | =depth="2"= | Limit depth of headings shown in TOC | TOC_MAX_DEPTH if defined. Otherwise 6 |
    | =mindepth="2"= | Specify the minimum depth of headings | TOC_MIN_DEPTH if defined. Otherwise 1 |
    | =title="Some text"= | Title to appear at top of TOC | none (TOC_TITLE setting) |
    | =style="..."= | Style to apply to the TOC | none (TOC_STYLE setting) |
   * Example: =%<nop>TOC{depth="2"}%=
   * Example: =%<nop>TOC{"TWikiDocumentation" web="%SYSTEMWEB%" title="Contents:" style="float: right;"}%=
   * Category: FormattingAndRenderingVariables, UIAndVisualizationVariables
   * Related: [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarINCLUDE][INCLUDE]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarTOC][TOC]]

This topic: TWiki > WebHome > TWikiVariables > VarTOC2
Topic revision: r7 - 2014-06-16 - TWikiContributor

Copyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.VarTOC2.