Vorlage:TOC right/Doku

Dies ist eine nachgeordnete Seite der Dokumentation von Vorlage:TOC right.
Sie enthält Informationen zur Verwendung, Kategorisierung und zu anderem Inhalt, der nicht Bestandteil der originalen Vorlage-Seite ist.

Diese Vorlage verwendet TemplateStyles. Die Stilvorlagen sind in der Datei Vorlage:TOC right/styles.css notiert.

Die Vorlage {{TOC right}} erzwingt die rechts umflossene Anzeige des automatisch generierten Inhaltsverzeichnisses für einen Artikel, um das Artikellayout zu verbessern.

Verwendung

Man füge {{TOC right}} an der Stelle im Artikel ein, an der der obere Rand des Inhaltsverzeichnis erscheinen soll. Dies sollte normalerweise nach dem Text des einleitenden Abschnitts und direkt vor der ersten Abschnittsüberschrift stehen. {{-}} oder {{clear}} kann verwendet werden, um Kollisionen mit Text zu vermeiden. Man verwende den clear-Parameter (siehe unten), um Kollisionen mit Bildern zu vermeiden.

Man vermeide es, das Inhaltsverzeichnis an einem schlecht sichtbaren Ort zu platzieren. Das Überqueren zum Folgeabschnitt ist wahrscheinlich eine schlechte Idee.

Optionale Parameter

|clear= Legt die CSS-Eigenschaft clear fest, die diesen Umfluss unter die mit diesem Attribut angegebene Stelle erzwingt. So platziert clear = right (dies ist die Standardeinstellung) das Element nach allen davor befindlichen umflossenen Elementen. Mögliche Werte sind left, right, both oder none.
|width= Legen Sie die CSS-Breite fest.
|limit= Begrenzt die Tiefe der angezeigten Unterüberschriften. Zum Beispiel blendet die Verwendung limit = 4 die vierte Ebene und tiefere Unterüberschriften in der Hierarchie aus. Und limit = 2 blendet alle Unterüberschriften aus und lässt nur die Hauptüberschriften übrig. Dies ist als CSS-Klasse in MediaWiki:Common.css implementiert.

Hinweise

Verwenden Sie diese Vorlage nicht, um einfach einen Zeilenumbruch um das Inhaltsverzeichnis zu erzwingen, da dies eine ungeeignete Methode ist, um dies zu erreichen. Fügen Sie stattdessen eine CSS-Klasse zur .css-Datei Ihres aktuellen Skins hinzu, die für die gesamte Website gilt. Gehen Sie zu Special:Mypage/skin.css, das zur CSS-Datei Ihres aktuellen Skins weiterleitet.

Platzieren Sie diese Vorlage nicht so, dass das Inhaltsverzeichnis an einem großen Bild oder einer breiten Infobox ausgerichtet ist. Dadurch wird das Layout auf schmalen Bildschirmen unterbrochen (sogar Benutzer mit Bildschirmen mit einer Breite von bis zu 1024 Pixel könnten Probleme haben). Außerdem ist ein Inhaltsverzeichnis, das in den Folgeabschnitt ragt, wahrscheinlich eine schlechte Idee und solte vermieden werden.

Wenn der Abschnitt, in dem {{TOC right}} platziert wird, nicht lang genug ist, kann das Ergebnis durchaus unerwünscht sein.

Die Vorlage sollte nur in den Fällen verwendet werden, in denen das Inhaltsverzeichnis anderen Inhalten im Weg steht oder das Layout der Seite beeinträchtigt wird. Es sollte nicht aus rein ästhetischen Gründen verwendet werden, da es das standardmäßige Erscheinungsbild von Artikeln beeinträchtigt.

Verwendete Stilvorlagen

Vorlage:TOC right/styles.css

Siehe auch