X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/dce4e6206cde86b14b6d70ede1b35ba49329b021..219afc3f9c646f323c9a51744b6fba43f04786db:/doc/plugins/toc.mdwn diff --git a/doc/plugins/toc.mdwn b/doc/plugins/toc.mdwn index b53cf158f..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 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.