Merge remote-tracking branch 'refs/remotes/dgit/dgit/sid'

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

diff --git a/doc/ikiwiki/directive/toc.mdwn b/doc/ikiwiki/directive/toc.mdwn
index 94b0fe1af67c42db04cbe07b7c53b59bf6dc14c3..bb1afa1acdc98bebff9f0cf887425d66dfd6552a 100644 (file)
--- a/doc/ikiwiki/directive/toc.mdwn
+++ b/doc/ikiwiki/directive/toc.mdwn
@@ -1,4 +1,4 @@
-The `toc` directive is supplied by the [[!iki plugins/toc]] plugin.
+The `toc` directive is supplied by the [[!iki plugins/toc desc=toc]] plugin.

 
 Add a table of contents to a page:
 
 
 Add a table of contents to a page:
 


@@ -14,6 +14,12 @@ the `levels` parameter:
 The toc directive will take the level of the first header as the topmost
 level, even if there are higher levels seen later in the file.
 
 The toc directive will take the level of the first header as the topmost
 level, even if there are higher levels seen later in the file.
 

+To create a table of contents that only shows headers starting with a given
+level, use the `startlevel` parameter. For example, to show only h2 and
+smaller headers:
+
+       \[[!toc startlevel=2]]
+

 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.
 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.