summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/toc.mdwn
blob: 7bdf15d0d33053e07543926828d366f09b7be7de (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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"]]