X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/d7deeb44dbd1c0da407ad52f5ed7255fd132547b..d6c73e9ef6dcd89ade9ca64755d683ac88d46ae7:/doc/plugins/toc.mdwn?ds=sidebyside diff --git a/doc/plugins/toc.mdwn b/doc/plugins/toc.mdwn index 78ce712e2..149ac041e 100644 --- a/doc/plugins/toc.mdwn +++ b/doc/plugins/toc.mdwn @@ -1,13 +1,20 @@ -[[template id=plugin name=toc author="[[Joey]]"]] -[[tag type/chrome]] +[[!template id=plugin name=toc author="[[Joey]]"]] +[[!tag type/chrome]] -Add a table of contents be to a page: +Add a table of contents to a page: - \[[toc ]] + \[[!toc ]] The table of contents will be automatically generated based on the headers of the page. By default only the largest headers present on the page will be shown; to control how many levels of headers are shown, use the `levels` parameter: - \[[toc levels=2]] + \[[!toc levels=2]] + +The toc plugin will take the level of the first header as the topmost +level, even if there are higher levels seen later in the file. + +The table of contents will be created as an ordered list. If you want +an unordered list instead, you can change the list-style in your local +style sheet.