summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/toc.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'ikiwiki/directive/toc.mdwn')
-rw-r--r--ikiwiki/directive/toc.mdwn29
1 files changed, 29 insertions, 0 deletions
diff --git a/ikiwiki/directive/toc.mdwn b/ikiwiki/directive/toc.mdwn
new file mode 100644
index 0000000..aebb4d6
--- /dev/null
+++ b/ikiwiki/directive/toc.mdwn
@@ -0,0 +1,29 @@
+Die `toc`-Anweisung wird durch die [[!iki plugins/toc desc=toc]]-Erweiterung
+bereitgestellt.
+
+Sie fügt ein Inhaltsverzeichnis in eine Seite ein:
+
+ \[[!toc ]]
+
+Das Inhaltsverzeichnis wird automatisch ausgehend von den Überschriften der
+Seite erzeugt. In der Voreinstellung werden nur die größten Überschriften
+der Seite angezeigt; mit dem Parameter `levels` kann aber die Anzahl der
+angezeigten Überschriftsebenen gesteuert werden:
+
+ \[[!toc levels=2]]
+
+Die `toc`-Anweisung verwendet die Ebene der ersten Überschrift als die
+oberste, selbst wenn es weiter unten in der Datei höhere Überschriften gibt.
+
+Um in einem Inhaltsverzeichnis nur die Überschriften beginnend mit einer
+bestimmten Ebene anzuzeigen, kann der `startlevel`-Parameter verwendet
+werden. Zum Beispiel, um nur <h2>- und kleinere Überschriften
+anzuzeigen:
+
+ \[[!toc startlevel=2]]
+
+Das Inhaltsverzeichnis wird als nummerierte Liste erzeugt. Um eine
+ungeordnete Liste zu erhalten, kann `list-style` im lokalen Stylesheet
+verändert werden.
+
+[[!meta robots="noindex, follow"]]