| |
| META TOPICPARENT |
name="TWikiVariables" |
TOC{"Topic"} -- table of contents
- Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax (
"---++ text") and HTML ("<h2>text</h2>") 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".
- Syntax:
%TOC{"SomeTopic" ...}%
- Supported parameters:
|
|
<
< |
"TopicName" |
topic name |
Current topic |
|
>
> |
"TopicName" |
Topic name |
Current topic |
|
| |
web="Name" |
Name of web |
Current web |
depth="2" |
Limit depth of headings shown in TOC |
6 |
|
|
<
< |
title="Some text" |
Title to appear at top of TOC |
none |
|
>
> |
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:
%TOC{depth="2"}%
|
|
<
< |
- Example:
%TOC{"TWikiDocumentation" web="TWiki" title="Contents:"}%
|
>
> |
- Example:
%TOC{"TWikiDocumentation" web="TWiki" title="Contents:" style="float: right;"}%
|
|
>
> | |
| | |
Copyright © 1999-2025 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.
