filecheck: Fall back to testing for binary or plain text files if no mime type is...

[ikiwiki.git] / doc / plugins / toc.mdwn

diff --git a/doc/plugins/toc.mdwn b/doc/plugins/toc.mdwn
index b53cf158fb98527395ee0f6f8c2ff900f0236a0b..149ac041e63e9c577bf358aa5bb0e19046871683 100644 (file)
--- 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.