Help/CreateTocPlugin

The CreateToc plugin allows to create a dynamical Table of Contents of all headers. It also allows to number the headers in the page.

The headers might be in classic Phpwiki syntax or in Wikicreole/Mediawiki syntax (see below).

The Table of Contents can easily be inserted by clicking on the TOC button in the Edit toolbar.

Usage

<<CreateToc arguments>>

Arguments

Argument	Description	Default value
extracollapse	Boolean. If true, provide a button to hide/display the Table of Contents.	true
firstlevelstyle	Style of first level numbering: number, letter or roman.	number
headers	Which headers to include. See below.	1,2,3,4,5
indentstr	Indent string.	  
jshide	Boolean. If true, the Table of Contents should be initially hidden and on click expanded.	false
liststyle	List style: dl or ol or ul. Using ol is equivalent to with_counter=1.	dl
noheader	Boolean. If true, the Table of Contents header should be omitted.	false
notoc	Boolean. If true, the Table of Contents should no be displayed (headers are numbered).	false
pagename	Table of Contents of which page?	current pagename
position	Where to display the Table of Contents: full, left or right.	full
version	Page version	Most recent version
width	Width of Table of Contents (if position is left or right)	200px
with_counter	Boolean. If true, hierarchical prefixes should be added.	false
with_toclink	Boolean. If true, headers should link back to the Table of Contents.	false

Headers

Syntax: a comma-separated list of levels. !!!,!!,! also allowed

Level	Phpwiki syntax	Wikicreole/Mediawiki syntax	HTML rendering
1	!!!	==	h2
2	!!	===	h3
3	!	====	h4
4	none	=====	h5
5	none	======	h6

Examples

Default values

<<CreateToc>>

Only two levels of headers

<<CreateToc headers=1,2>>

Table of Contents with hierarchical numbering

<<CreateToc with_counter=1>>

No Table of Contents, but headers are numbered

<<CreateToc notoc=1>>

Table of Contents with hierarchical numbering, first level in roman

<<CreateToc with_counter=1 firstlevelstyle=roman>>

See Also

• Help:TextFormattingRules

Known Problems

• If you include pages via Template or IncludePage plugins, the Table of Contents will not contain the headers of the included pages.

• The Table of Contents will be incorrect if a header contains:

  • a Template plugin call via {{ }},
  • an image,
  • or a ~.
• If you preview the page, the Table of Contents will not be correct if you modified headers. The Table of Contents will be taken from the last saved revision.