]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/plugins/toc.mdwn
Mark done.
[ikiwiki.git] / doc / plugins / toc.mdwn
index c1f8f25f0c3d81a1065d4aa05a7ba4f4f9c2c68d..2b7686681ee110072fd8576da0a98e30b1fff91d 100644 (file)
@@ -1,20 +1,5 @@
-[[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 ]]
-
-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]]
-
-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.
\ No newline at end of file
+This plugin provides the [[ikiwiki/directive/toc]] [[ikiwiki/directive]],
+which adds a table of contents to a page.