Date: Sat, 12 Aug 2008 15:51:24 +0000
Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
X-Rcs-Id: $Id: Help%2FCreateTocPlugin,v 1.6 2008-08-17 07:37:17 vargenau Exp $
Content-Type: application/x-phpwiki;
  pagename=Help%2FCreateTocPlugin;
  flags=PAGE_LOCKED;
  markup=2;
  charset=iso-8859-1
Content-Transfer-Encoding: binary

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.

!!! Usage
<verbatim>
     <?plugin CreateToc ?>
     <?plugin CreateToc jshide||=1 with_toclink||=1 ?>
</verbatim>

!!! Arguments
__jshide__: |
  Boolean if the Table of Contents should be initially hidden and on click expanded. Default: false
__with_toclink__:  |
  Boolean if headers should link back to the Table of Contents. Default: false
__with_counter__:  |
  Boolean if hierarchical prefixes should be added. Default: false
__headers__:  |
  Which headers to include.  Default: 1,2,3,4,5
__noheader__:  |
  Boolean if the Table of Contents header should be omitted. Default: false
__notoc__:  |
  Boolean if the Table of Contents should no be displayed (headers are numbered). Default: false
__liststyle__:  |
  dl or ol or ul. Default: dl
__firstlevelstyle__: |
  number, letter or roman. Default: number
__indentstr__:  |
  Default: &nbsp;&nbsp;
__pagename__:  |
  Table of Contents of which page? Default: current pagename

!! Headers

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

{| border=1
|-
| Level
| Phpwiki syntax
| Wikicreole syntax
| HTML rendering
|-
| 1 || ~!~!~! || ~=~= || h2
|-
| 2 || ~!~! || ~=~=~= || h3
|-
| 3 || ~! || ~=~=~=~= || h4
|-
| 4 || ''None'' || ~=~=~=~=~= || h5
|-
| 5 || ''None'' || ~=~=~=~=~=~= || h6
|}

!!! Examples

See for example 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.
* If a header contains a [Template|Help:TemplatePlugin]  plugin call via ~{~{ ~}~} or an image, the Table of Contents will be incorrect.
* 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]