|
|
This macro generates a Table of Contents for the current page based on its headings. DetailsVersions of this plugin prior to 2.3 require the appropriate Utilities Plugin to be installed into WEB-INF/lib. This macro generates a Table of Contents for the current page based on its headings. Overview
Bugs & Feature RequestsBug reports and feature requests are available in JIRA. To view the macro's documentation, click on its name below. {toc}Generate a table of contents based on what headings are present in the current page. more info... {toc-zone}Generates a table of contents based on what headings are present within its body. more info... The examples are based on a page with the following basic content: h1. Level 1 h2. Level 1.1 h3. Level 1.1.1 h2. Level 1.2 h3. Level 1.2.1 h1. Level 2 h2. Level 2.1 Basic Table of ContentsThis will list all headings of level 1 or 2 in outline style. {toc:outline=true|style=none|maxLevel=2}
Filtered Table of ContentsThis will list all headings that end with '.1' or '.2' as a flat list with each item separated by ' - '. See Sun's Regex documentation for details on how to use this. {toc:type=flat|separator=" - "|filter=.*\.[1//2]}
The TOC ZoneBelow is an example of the {toc-zone} macro in action. This macro will only list headings which occur in inside the macro body - that is, 'Level 1.1' through 'Level 1.2.1'. You can specify if the TOC should appear at the top, bottom or in both locations. Otherwise, it has the same options as the regular {toc} macro. h1. Level 1
{toc-zone:separator=pipe|location=top}
h2. Level 1.1
h3. Level 1.1.1
h2. Level 1.2
h3. Level 1.2.1
{toc-zone}
h1. Level 2
h2. Level 2.1
For information on installing the plugins once you've downloaded them, see these instructions. Confluence 2.3+
Confluence 1.4/2.0/2.1/2.2This is the version to install if you are using Confluence 1.4, 2.0, 2.1 or 2.2.
Confluence 1.3This is the version to install if you are using Confluence 1.3.
|
Table of Contents Plugin
|
|
|
Discussions