1 Date: Sat, 24 Jan 2009 8:15:24 +0000
2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
4 Content-Type: application/x-phpwiki;
5 pagename=Help%2FCreateTocPlugin;
9 Content-Transfer-Encoding: binary
11 The *~CreateToc* [plugin|Help:WikiPlugin] allows to create a dynamical *Table of Contents* of all headers. It also allows to number the headers in the page.
13 The headers might be in classic Phpwiki syntax or in Wikicreole/Mediawiki syntax (see below).
15 The Table of Contents can easily be inserted by clicking on the TOC button in the Edit toolbar.
19 <?plugin CreateToc arguments ?>
30 | <b>extracollapse</b>
31 | Provide a button to hide/display the Table of Contents
34 | <b>firstlevelstyle</b>
35 | Style of first level numbering: number, letter or roman.
39 | Which headers to include. See below.
47 | Boolean if the Table of Contents should be initially hidden and on click expanded.
51 | List style: dl or ol or ul. Using ol is equivalent to with_counter=1.
55 | Boolean if the Table of Contents header should be omitted.
59 | Boolean if the Table of Contents should no be displayed (headers are numbered).
63 | Table of Contents of which page?
67 | Where to display the Table of Contents: full, left or right.
71 | Width of Table of Contents (if position is left or right)
75 | Boolean if hierarchical prefixes should be added.
79 | Boolean if headers should link back to the Table of Contents.
85 Syntax: a comma-separated list of levels. !!!,!!,! also allowed
91 | Wikicreole/Mediawiki syntax
94 | 1 || ~!~!~! || ~=~= || h2
96 | 2 || ~!~! || ~=~=~= || h3
98 | 3 || ~! || ~=~=~=~= || h4
100 | 4 || ''None'' || ~=~=~=~=~= || h5
102 | 5 || ''None'' || ~=~=~=~=~=~= || h6
109 <?plugin CreateToc ?>
112 !! Only two levels of headers
114 <?plugin CreateToc headers=1,2 ?>
117 !! Table of Contents with hierarchical numbering
119 <?plugin CreateToc with_counter=1 ?>
122 !! No Table of Contents, but headers are numbered
124 <?plugin CreateToc notoc=1 ?>
127 !! Table of Contents with hierarchical numbering, first level in roman
129 <?plugin CreateToc with_counter=1 firstlevelstyle=roman ?>
132 See also [PhpWikiDemo:en/TextFormattingRules]
136 * If you include pages via [Template|Help:TemplatePlugin] or [IncludePage|Help:IncludePagePlugin] plugins, the Table of Contents will not contain the headers of the included pages.
137 * The Table of Contents will be incorrect if a header contains:
138 ** a [Template|Help:TemplatePlugin] plugin call via ~{~{ ~}~},
141 * 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.
142 * If you display an old revision of a page, the Table of Contents will not be correct. The Table of Contents will be taken from the last saved revision.
145 [PhpWikiDocumentation] [CategoryWikiPlugin]