Date: Sat, 21 Feb 2009 21:18:47 +0000
Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
X-Rcs-Id: $Id$
Content-Type: application/x-phpwiki;
pagename=Help%2FCreateTocPlugin;
flags=PAGE_LOCKED;
markup=2;
charset=iso-8859-1
Content-Transfer-Encoding: binary
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.
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
<>
!!! Arguments
{| class="bordered"
|-
! Argument
! Description
! Default value
|-
| extracollapse
| 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 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 the Table of Contents header should be omitted.
| false
|-
| notoc
| Boolean if 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
|-
| width
| Width of Table of Contents (if position is left or right)
| 200px
|-
| with_counter
| Boolean if hierarchical prefixes should be added.
| false
|-
| with_toclink
| Boolean if headers should link back to the Table of Contents.
| false
|}
!! Headers
Syntax: a comma-separated list of levels. !!!,!!,! also allowed
{| class="bordered"
|-
| Level
| Phpwiki syntax
| Wikicreole/Mediawiki syntax
| HTML rendering
|-
| 1 || ~!~!~! || ~=~= || h2
|-
| 2 || ~!~! || ~=~=~= || h3
|-
| 3 || ~! || ~=~=~=~= || h4
|-
| 4 || ''None'' || ~=~=~=~=~= || h5
|-
| 5 || ''None'' || ~=~=~=~=~=~= || h6
|}
!!! Examples
!! Default values
<>
!! Only two levels of headers
<>
!! Table of Contents with hierarchical numbering
<>
!! No Table of Contents, but headers are numbered
<>
!! Table of Contents with hierarchical numbering, first level in roman
<>
See also [PhpWikiDemo:en/TextFormattingRules]
!!! Known Problems
* 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.
* The Table of Contents will be incorrect if a header contains:
** a [Template|Help:TemplatePlugin] 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.
* 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.
----
[[PhpWikiDocumentation]] [[CategoryWikiPlugin]]