You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 8
Next »
This macro generates a Table of Contents for the current page based on its headings.
Table of Contents Plugin
- toc - Generates a table of contents based on what headings are present in the current page.
- toc-zone - Lists all the headings within the macro's body.
Generates a table of contents based on what headings are present in the current page.
The Code
Error: The XML content could not be parsed. There is a problem at line 21, column 4. Parser message: Unexpected close tag </ul>; expected </div>. at [row,col {unknown-source}]: [21,4]
Name |
Required? |
Default |
Description |
type |
![](/confluence/images/icons/emoticons/error.png)
|
list |
The type of TOC to output. May be 'list' or 'flat'. |
outlne |
![](/confluence/images/icons/emoticons/error.png)
|
false |
If true each item will be prefixed by a hierarcical number (e.g. '1.3'). |
style |
![](/confluence/images/icons/emoticons/error.png)
|
none |
The style of bullet-point to use for each item. Any CSS styles are valid. |
separator |
![](/confluence/images/icons/emoticons/error.png)
|
brackets |
he type of separator when in 'flat' mode. May be any of the following:
- 'brackets' - Each item is surrounded by square brackets
- 'braces' - Each item is surrounded by curly braces.
- 'parens' - Each item is surrounded by parentheses.
- 'pipe' - Each item is separated by a pipe.
|
- anything - Each item is separated by the value supplied. Nothing is placed on the outsides of the list.|
indent |
![](/confluence/images/icons/emoticons/error.png)
|
|
When displayed as a 'list', the amount to indent each heading level. Note: This is a CSS quantity, so make sure you use the quantity type (eg. '10px' not '10'). |
minLevel |
![](/confluence/images/icons/emoticons/error.png)
|
1 |
The minimum level to report headings for, inclusive. Eg. '2' will list 'h2.' and 'h3.' headings, but not 'h1.'. |
maxLevel |
![](/confluence/images/icons/emoticons/error.png)
|
7 |
The maximum level to report headings for, inclusive. Eg. '2' will list 'h1.' and 'h2.' headings, but not 'h3.' or above. |
include |
![](/confluence/images/icons/emoticons/error.png)
|
|
If set, any headings not matching the regular expression will be ignored. |
exclude |
![](/confluence/images/icons/emoticons/error.png)
|
|
If set, any headings which do match the regular expression will be ignored. |
name |
![](/confluence/images/icons/emoticons/error.png)
|
|
Parameter description goes here. |
printable |
![](/confluence/images/icons/emoticons/error.png)
|
true |
If set to false, the TOC will not be visible when printing. |
class |
![](/confluence/images/icons/emoticons/error.png)
|
|
If specified, a <div> surrounding the TOC will be output with the specified 'class' attribute. Use CSS styles to customise the look of the TOC. |
The Code
Name |
Required? |
Default |
Description |
deck: com.atlassian.confluence.macro.MacroExecutionException: java.lang.NullPointerException
Unknown macro: {roundrect}