Vorlage:TOC limit/Doku

Diese Seite ist die Dokumentations-Unterseite der Vorlage:TOC limit.

Diese Vorlage dient dazu, die Gliederungstiefe des Inhaltsverzeichnisses zu beschränken. Dies kann besonders bei langen, stark gegliederten Seiten hilfreich sein, um dem Leser ein übersichtliches Inhaltsverzeichnis zu präsentieren. Die Vorteile von Überschriften innerhalb der Seite bleiben erhalten, auch wenn sie nicht mehr im Inhaltsverzeichnis angezeigt werden. Über ihren Bearbeitenlink können Abschnitte weiterhin schneller bearbeitet werden und Nutzer von Hilfsmitteln können die Überschriften direkt anspringen (→ Wikipedia:Barrierefreiheit).

Parameter und Kopiervorlagen

Ohne Angabe des Parameters werden zwei Gliederungsebenen (== … == und === … ===) angezeigt:
{{TOC limit}}

Für die Anzeige weiterer Ebenen ist die gewünschte Tiefe über den Parameter anzugeben, der die angezeigte Tiefe des Inhaltsverzeichnisses einstellt. Diese Parameter-Zahl entspricht in der Regel der Überschriftenebene. Die Überschriftenebene 1 (= … =) wird normalerweise nicht manuell in Seiten eingesetzt und ist vom Inhaltsverzeichnis ausgeschlossen. Die Zählung des Parameters ist daher immer um 1 höher als die Anzahl der angezeigten Gliederungsebenen. Mehr als fünf Gliederungsebenen werden aktuell nicht von der MediaWiki-Software unterstützt.

Mit dem Parameter-Wert 4 werden also drei Gliederungsebenen (bis einschließlich Überschriftenebene 4, also ==== … ====) angezeigt:
{{TOC limit|4}}

Code	Anzahl Gliederungsebenen	Vorschau
{{TOC limit|2}}	1 (bis == … ==)	1 Überschrift
{{TOC limit|3}} bzw. {{TOC limit}}	2 (bis === … ===)	1 Überschrift 1.1 Überschrift
{{TOC limit|4}}	3 (bis ==== … ====)	1 Überschrift 1.1 Überschrift 1.1.1 Überschrift
{{TOC limit|5}}	4 (bis ===== … =====)	1 Überschrift 1.1 Überschrift 1.1.1 Überschrift 1.1.1.1 Überschrift

Beispiele

Beispiel mit sauberer Gliederung

Mit {{TOC limit}} wird

== Weblinks ==
=== Neue Weblinks ===
==== Weblinks von 2009 ====
==== Weblinks von 2010 ====
==== Weblinks von 2011 ====
=== Alte Weblinks ===
== Einzelnachweise ==

zu

1 Weblinks
1.1 Neue Weblinks
1.2 Alte Weblinks
2 Einzelnachweise

Beispiel mit unsauberer Gliederung

Werden Überschriftenebenen ausgelassen, werden die Überschriften dennoch dem Inhaltsverzeichnis hinzugefügt und fortlaufend nummeriert. In diesem Fall entspricht die Zahl des Parameters nicht mehr der Zahl der Überschriftenebene.

Mit {{TOC limit}} wird

== Weblinks ==
==== Neue Weblinks ====
=== Alte Weblinks ===
== Einzelnachweise ==

trotzdem zu

1 Weblinks
1.1 Neue Weblinks
1.2 Alte Weblinks
2 Einzelnachweise

da das Inhaltsverzeichnis zwei Gliederungsebenen anzeigt, auch wenn diese nicht semantisch korrekt direkt aufeinander folgen.

Technische Umsetzung

Diese Vorlage ergänzt eine CSS-Klasse toclimit-?, die mithilfe einer CSS-Anweisung in der MediaWiki:Common.css ausgeblendet wird.