diff options
| -rw-r--r-- | ikiwiki/directive/toc.mdwn | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/ikiwiki/directive/toc.mdwn b/ikiwiki/directive/toc.mdwn new file mode 100644 index 00000000..7bdf15d0 --- /dev/null +++ b/ikiwiki/directive/toc.mdwn @@ -0,0 +1,32 @@ +[[!if test="enabled(toc)" + then="In diesem Wiki ist die Direktive: toc **aktiviert**." + else="In diesem Wiki ist die Direktive: toc **nicht aktiv**. ; falls dies gewünscht wird, den Admin benachrichtigen."]] + +--- +The `toc` directive is supplied by the [[!iki plugins/toc desc=toc]] plugin. + +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 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"]] |