summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/toc.mdwn
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2010-10-14 13:38:20 +0200
committerJonas Smedegaard <dr@jones.dk>2010-10-14 13:38:20 +0200
commitce0037e0ff41a75d0e6c947ef547ef9630c54be9 (patch)
tree829062b1e1922c423aa31be44a4896a5944e5c07 /ikiwiki/directive/toc.mdwn
Sync with ikiwiki 3.20100926.HEADmasterikiwiki
Diffstat (limited to 'ikiwiki/directive/toc.mdwn')
-rw-r--r--ikiwiki/directive/toc.mdwn27
1 files changed, 27 insertions, 0 deletions
diff --git a/ikiwiki/directive/toc.mdwn b/ikiwiki/directive/toc.mdwn
new file mode 100644
index 0000000..2593b95
--- /dev/null
+++ b/ikiwiki/directive/toc.mdwn
@@ -0,0 +1,27 @@
+The `toc` directive is supplied by the [[!iki plugins/toc desc=toc]] plugin.
+
+Tilføje en indholdsfortegnelse til en side:
+
+ \[[!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 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.
+
+[[!meta robots="noindex, follow"]]