pgsrc/Help%2FCreateTocPlugin

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