<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link rel="home" title="HomePage" href="HomePage.html" />
<link rel="help" title="HowToUseWiki" href="HowToUseWiki.html" />
<link rel="copyright" title="GNU General Public License" href="http://www.gnu.org/copyleft/gpl.html#SEC1" />
<link rel="author" title="The PhpWiki Programming Team" href="http://phpwiki.org/ThePhpWikiProgrammingTeam" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="Content-Language" content="en" />
<meta name="robots" content="noindex,nofollow" />
<meta name="language" content="en" />
<meta name="document-type" content="Public" />
<meta name="document-rating" content="General" />
<meta name="generator" content="PhpWiki" />
<meta name="PHPWIKI_VERSION" content="1.3.14" />

<base href="../" />
<link rel="stylesheet" type="text/css" charset="iso-8859-1" href="phpwiki-printer.css" />
<title>PhpWiki - Help  /  Create Toc Plugin</title>
</head>
<body>

<div id="header">
  
<!-- Page title -->
<h1>Help  /  Create Toc Plugin</h1>
</div>
<div id="content">



<div class="wikitext"><div class="plugin tightenable top" id="CreateTocPlugin"><div class="toc" id="toc"><script type="text/javascript">
<!--//
function toggletoc(a) {
  var toc=document.getElementById('toclist')
  //toctoggle=document.getElementById('toctoggle')
  var open='/phpwiki/themes/default/images/folderArrowOpen.png'
  var close='/phpwiki/themes/default/images/folderArrowClosed.png'
  if (toc.style.display=='none') {
    toc.style.display='block'
    a.title='Click to hide the TOC'
    a.src = open
  } else {
    toc.style.display='none';
    a.title='Click to display'
    a.src = close
  }
}
// --></script>
<h4>Table Of Contents <a name="TOC"></a><img id="toctoggle" class="wikiaction" title="Click to display to TOC" onClick="toggletoc(this)" height="15" width="15" border="0" src="/phpwiki/themes/default/images/folderArrowClosed.png" /></h4>
<dl id="toclist" class="toc" style="display:none;">
<dt>&nbsp;&nbsp;<a href="Help/CreateTocPlugin.html#Usage" class="named-wiki" title="Help/CreateTocPlugin">Usage</a></dt>
<dt>&nbsp;&nbsp;<a href="Help/CreateTocPlugin.html#Plugin_Arguments" class="named-wiki" title="Help/CreateTocPlugin">Plugin Arguments</a></dt>
<dt>&nbsp;&nbsp;<a href="Help/CreateTocPlugin.html#Examples" class="named-wiki" title="Help/CreateTocPlugin">Examples</a></dt>
</dl>
</div>
</div>
<p class="tightenable"><a href="Help/WikiPlugin" class="interwiki"><span style="white-space: nowrap"><img src="images/interwiki.png" alt="" class="linkicon" border="0" />Help:</span><span class="wikipage">WikiPlugin</span></a> to create a dynamical <b>Table Of Contents</b> of all headers. Since v1.3.8</p>
<h3><a name="Usage"></a>Usage</h3>
<pre class="tightenable top">
     &lt;?plugin CreateToc ?&gt;
     &lt;?plugin CreateToc jshide||=1 with_toclink||=1 ?&gt;</pre>
<h3><a name="Plugin_Arguments"></a>Plugin Arguments</h3>
<table class="wiki-dl-table" border="1" cellspacing="0" cellpadding="6"><tr class="tightenable top bottom"><th><strong>jshide</strong>:</th>
<td>Boolean if the TOC should be initially hidden and on click expanded. Default: 0</td>
</tr>
<tr class="tightenable top bottom"><th><strong>with_toclink</strong>:</th>
<td>Boolean if headers should link back to the TOC. Default: false</td>
</tr>
<tr class="tightenable top bottom"><th><strong>with_counter</strong>:</th>
<td>Boolean if hierarchical prefixes should be added. Default: false</td>
</tr>
<tr class="tightenable top bottom"><th><strong>headers</strong>:</th>
<td>Which headers to include.  Default: !!!,!!,!    1,2,3 also allowed</td>
</tr>
<tr class="tightenable top bottom"><th><strong>noheader</strong>:</th>
<td>Boolean if the &quot;Table of Contents&quot; h2 header should be omitted. Default: 0</td>
</tr>
<tr class="tightenable top bottom"><th><strong>liststyle</strong>:</th>
<td>dl or ol or ul. Default: dl</td>
</tr>
<tr class="tightenable top bottom"><th><strong>indentstr</strong>:</th>
<td>Default: &amp;nbsp;&amp;nbsp;</td>
</tr>
<tr class="tightenable top"><th><strong>pagename</strong>:</th>
<td>TOC of which page? Default: current pagename</td>
</tr>
</table>
<h3><a name="Examples"></a>Examples</h3>
<p class="tightenable bottom">See for example <a href="http://phpwiki.sourceforge.net/demo/en/TextFormattingRules" class="interwiki"><span style="white-space: nowrap"><img src="images/interwiki.png" alt="" class="linkicon" border="0" />PhpWikiDemo:</span><span class="wikipage">en/TextFormattingRules</span></a></p>
<hr />
<p class="tightenable bottom"><a href="PhpWikiDocumentation.html" class="wiki">PhpWikiDocumentation</a> <a href="Help/WikiPlugin" class="interwiki"><span style="white-space: nowrap"><img src="images/interwiki.png" alt="" class="linkicon" border="0" />Help:</span><span class="wikipage">WikiPlugin</span></a></p>
</div>

<div id="footer">  <hr class="printer" noshade="noshade" />
<p class="editdate">Owner: &quot;admin&quot;  Last edited on August 14, 2007  7:11 am by &quot;The PhpWiki programming team&quot;</p>
</div>

</div>
<!-- Add your Disclaimer here -->
</body>
</html>
