pgsrc/Help%2FCreateTocPlugin

   1 Date: Mon, 16 Jun 2008 14:15:24 +0000
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
   3 X-Rcs-Id: $Id: Help%2FCreateTocPlugin,v 1.3 2008-06-18 01:12:39 vargenau Exp $
   4 Content-Type: application/x-phpwiki;
   5   pagename=Help%2FCreateTocPlugin;
   6   flags=PAGE_LOCKED;
   7   markup=2;
   8   charset=iso-8859-1
   9 Content-Transfer-Encoding: binary
  10
  11 <?plugin CreateToc jshide||=1 ?>
  12
  13 The ~*CreateToc* [plugin|Help:WikiPlugin] allows to create a dynamical *Table Of Contents* of all headers. Since v1.3.8
  14
  15 !!! Usage
  16 <verbatim>
  17      <?plugin CreateToc ?>
  18      <?plugin CreateToc jshide||=1 with_toclink||=1 ?>
  19 </verbatim>
  20
  21 !!! Arguments
  22 __jshide__: |
  23   Boolean if the TOC should be initially hidden and on click expanded. Default: 0
  24 __with_toclink__:  |
  25   Boolean if headers should link back to the TOC. Default: false
  26 __with_counter__:  |
  27   Boolean if hierarchical prefixes should be added. Default: false
  28 __headers__:  |
  29   Which headers to include.  Default: !!!,!!,!    1,2,3 also allowed
  30 __noheader__:  |
  31   Boolean if the "Table of Contents" h2 header should be omitted. Default: 0
  32 __liststyle__:  |
  33   dl or ol or ul. Default: dl
  34 __indentstr__:  |
  35   Default: &nbsp;&nbsp;
  36 __pagename__:  |
  37   TOC of which page? Default: current pagename
  38
  39 !!! Examples
  40
  41 See for example PhpWikiDemo:en/TextFormattingRules
  42 -------------
  43
  44 [PhpWikiDocumentation] [CategoryWikiPlugin]