Automatisches Inhaltsverzeichnis

Auch verfügbar in English, Español, Française, Русский, 简体中文

Mit dieser Aktion erstellt man ein Inhaltsverzeichnis der jeweiligen Seite. Das Inhaltsverzeichnis wird automatisch mit Hilfe der im Text vorhandenen Überschriften (===, siehe Textformatierung) erstellt. Das Inhaltsverzeichnis verweist mit Hilfe von Ankern (<h[2-6] id="..."> und <a href=#...>) auf die jeweilige Überschrift im Text.

Die größtmögliche Überschrift (<h1>, bzw. == im Wiki-Syntax) wird standardmäßig nicht im Inhaltsverzeichnis verwendet, da diese Überschrift für den Seitentitel (vergleichbar mit dem Titel eines Buches) vorgesehen ist und nicht für einzelne Kapitel.

1. Syntax

{{toc page="SeitenName" legend="Titel" numerate=1 from="h2" to="h6" nomark=1}}
toc steht für Table of Contents (Inhaltsverzeichnis)

Parameter:

`page`	Der Parameter `page` enthält den Wikinamen der Seite, für die das Inhaltsverzeichnis erstellt wird. Wenn `page` leer ist oder überhaupt nicht angegeben wird, wird das Verzeichnis für die aktuelle Seite erstellt.
`legend`	Gibt die Überschrift für das Inhaltsverzeichnis an (Standardwert: Inhalt)
`numerate`	Die Überschriften werden automatisch durchnummeriert, auch wenn im Text keine Nummerierung angegeben wurde.
`start`	Legt einen bestimmten Anfangsnenner für die Nummerierung von Kapiteln fest.
`from` `to`	Gibt an, welche Überschriften im Inhaltsverzeichnis angezeigt werden sollen.
`nomark`	Mit dem Wert 1 wird das Inhaltsverzeichnis ohne Rahmen angezeigt.

Hinweis:

Alle Parameter sind optional, es ist möglich, nur {{toc}} zu verwenden.
Wenn du die Baumtiefe ändern willst, nutze die Parameter from und to.

{{toc from="h2" to="h4"}} sind die default Parameter

Alles was im Text als Überschrift gekennzeichnet ist, wird mit Ankern zu dem entsprechendem Abschnitten deiner Seite im Inhaltsverzeichnis aufgelistet.

Wichtig: falls du {{toc}} zusammen mit der Aktion {{include}} verwendest, aber nicht willst das die Überschriften der eingebundenen Seite mit in das Inhaltsverzeichnis aufgenommen werden, verwende die Option notoc wie folgt:

{{include page="Formatierung/Überschriften" notoc=1}}

2. Beispiele

a) Inhaltsverzeichnis für diese Seite:

Aufruf: {{toc}}

b) Für eine andere Seite:

Aufruf: {{toc page="/Doc/Deutsch/Formatierung"}}

c) wie b), jedoch mit Titel und Autonummerierung:

Aufruf: {{toc page="/Doc/Deutsch/Formatierung" legend="Formatierung mit Titel und Autonummerierung" numerate=1}}

d) wie c), jedoch mit Titel und der definierten Ebene (hier "h2" bis "h3"):

Aufruf: {{toc page="/Doc/Deutsch/Aktionen" title="Aktionen" numerate=0 from="h2" to="h3"}}

Referring pages:

zurück zur Übersicht