]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/plugins/toc.mdwn
Migrate doc/plugins via prefix_directives
[ikiwiki.git] / doc / plugins / toc.mdwn
index 78ce712e23b362b0700b8ab7859cc5bd13cb43e2..38db1d6afbb3f99d833f6370b5118c29d3e48368 100644 (file)
@@ -1,7 +1,7 @@
-[[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 ]]
 
@@ -11,3 +11,10 @@ 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