aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/toc.mdwn
diff options
context:
space:
mode:
authorWilliam Uther <willu@cse.unsw.edu.au>2008-09-11 17:05:51 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-09-11 17:05:51 -0400
commitc69a7f758590c91bd137a8d1cfa99f37bf28045a (patch)
tree16cbc730e9b63528b6a608856e8221b4fba40390 /doc/plugins/toc.mdwn
parent4f0ac7fe59c196a602e07cc6c4abfc248999ec6b (diff)
downloadikiwiki-c69a7f758590c91bd137a8d1cfa99f37bf28045a.tar
ikiwiki-c69a7f758590c91bd137a8d1cfa99f37bf28045a.tar.gz
patch plugin documentation to refer to directive pages
Diffstat (limited to 'doc/plugins/toc.mdwn')
-rw-r--r--doc/plugins/toc.mdwn19
1 files changed, 2 insertions, 17 deletions
diff --git a/doc/plugins/toc.mdwn b/doc/plugins/toc.mdwn
index 149ac041e..7e265fcec 100644
--- a/doc/plugins/toc.mdwn
+++ b/doc/plugins/toc.mdwn
@@ -1,20 +1,5 @@
[[!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.
+This plugin implements the [[ikiwiki/directive/toc]] [[ikiwiki/directive]].
+The directive adds table of contents to a page.