1 Date: Wed, 4 May 2011 17:46:02 +0000
2 Mime-Version: 1.0 (Produced by PhpWiki 1.4.0)
3 Content-Type: application/x-phpwiki;
4 pagename=Help%2FCreateTocPlugin;
5 flags=PAGE_LOCKED%2CEXTERNAL_PAGE;
8 Content-Transfer-Encoding: binary
10 The **~CreateToc** [[Help:WikiPlugin|plugin]] allows to create a dynamical **Table of Contents** of all headers. It also allows to number the headers in the page.
12 The headers might be in classic Phpwiki syntax or in Wikicreole/Mediawiki syntax (see below).
14 The Table of Contents can easily be inserted by clicking on the TOC button in the Edit toolbar.
18 <<CreateToc arguments>>
30 | Provide a button to hide/display the Table of Contents
34 | Style of first level numbering: //number//, //letter// or //roman//.
38 | Which headers to include. See below.
46 | Boolean if the Table of Contents should be initially hidden and on click expanded.
50 | List style: //dl// or //ol// or //ul//. Using //ol// is equivalent to //with_counter=1//.
54 | Boolean if the Table of Contents header should be omitted.
58 | Boolean if the Table of Contents should no be displayed (headers are numbered).
62 | Table of Contents of which page?
66 | Where to display the Table of Contents: //full//, //left// or //right//.
74 | Width of Table of Contents (if position is //left// or //right//)
78 | Boolean if hierarchical prefixes should be added.
82 | Boolean if headers should link back to the Table of Contents.
88 Syntax: a comma-separated list of levels. !!!,!!,! also allowed
94 ! Wikicreole/Mediawiki syntax
97 | 1 || ~!~!~! || ~=~= || h2
99 | 2 || ~!~! || ~=~=~= || h3
101 | 3 || ~! || ~=~=~=~= || h4
103 | 4 || //None// || ~=~=~=~=~= || h5
105 | 5 || //None// || ~=~=~=~=~=~= || h6
110 === Default values ===
115 === Only two levels of headers ===
117 <<CreateToc headers=1,2>>
120 === Table of Contents with hierarchical numbering ===
122 <<CreateToc with_counter=1>>
125 === No Table of Contents, but headers are numbered ===
127 <<CreateToc notoc=1>>
130 === Table of Contents with hierarchical numbering, first level in roman ===
132 <<CreateToc with_counter=1 firstlevelstyle=roman>>
136 * [[PhpWikiDemo:en/TextFormattingRules]]
140 * If you include pages via [[Help:TemplatePlugin|Template]] or [[Help:IncludePagePlugin|IncludePage]] plugins, the Table of Contents will not contain the headers of the included pages.
141 * The Table of Contents will be incorrect if a header contains:
142 ** a [[Help:TemplatePlugin|Template]] plugin call via ~{~{ ~}~},
145 * 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.
149 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]