Knuddels-Wiki:Handbuch08/3

< Knuddels-Wiki:Handbuch08



Überschriften

Im letzten Abschnitt hast du die Wikisyntax zu Überschriften bereits kennengelernt. In diesem Artikel wollen wir noch etwas detaillierter darauf eingehen.

Überschriften bieten eine gute Möglichkeit, einen Artikel zu strukturieren und automatisch ein Inhaltsverzeichnis zu erstellen, sofern man dies mittels __FORCETOC__ im Quelltext angibt oder es mindestens vier Überschriften in einem Artikel gibt.

Wikisyntax

Die Wikisyntax für Überschriften ist einfach: links und rechts von der Überschrift stehen gleich viele Gleichheitszeichen. Die Anzahl dieser Gleichheitszeichen gibt die Überschriftebene an. Es ist dabei darauf zu achten, dass die komplette Überschrift samt Gleichheitszeichen in einer Zeile steht. Dabei sollte zur besseren Lesbarkeit stets ein Leerzeichen zwischen der eigentlichen Überschrift und den Gleichheitszeichen stehen. Des Weiteren sollte zumindest vor einer neuen Überschrift immer eine Leerzeile stehen.

Darstellung Wikisyntax

Ebene 2

Text

Ebene 3

Text

Ebene 4

Text

Ebene 5

Text

Ebene 6

Text

== Ebene 2 ==
Text

=== Ebene 3 ===
Text

==== Ebene 4 ====
Text

===== Ebene 5 =====
Text

====== Ebene 6 ======
Text

Überschriften sind bis zur Ebene 6 möglich.

Die Überschrift mit nur einem Gleichheitszeichen = Überschrift = wird in Artikeln nicht verwendet, da diese Überschrift bereits für den Artikelnamen reserviert ist und sich alle anderen Überschriften dem Seitentitel unterordnen sollen. Folglich muss die erste Überschrift in einem Artikel eine Überschrift der Ebene 2 sein. Es ist zwar möglich, auch die Überschrift der ersten Ebene zu verwenden, dies sollte aus oben genannten Gründen jedoch vermieden werden.

Bearbeitung einzelner Abschnitte

Durch die Erstellung einer Überschrift wird automatisch ein Abschnitt erstellt, der unabhängig vom restlichen Artikel bearbeitet werden kann. So ist es möglich, sofern keine weiteren Überschriften gelöscht oder hinzugefügt werden, dass mehrere Benutzer gleichzeitig an einem Artikel, aber unterschiedlichen Abschnitten arbeiten. Bearbeitet man einen Abschnitt, so werden auch alle Unterabschnitte zur Bearbeitung im Quelltexteditor angezeigt.

Möchte man die Bearbeitung für die einzelnen Abschnitte deaktivieren, so geschiet dies mit __NOEDITSECTION__. Dies gilt allerdings für die gesamte Seite.

Des Weiteren wird bei der Bearbeitung eines Abschnitts ein Bearbeitungskommentar generiert, der automatisch einen Link zu diesem Abschnitt in der Versionsgeschichte erzeugt. Dies sollte nach Möglichkeit nicht verändert werden, da es die Übersichtlichkeit erheblich verbessert.

Inhaltsverzeichnis

Wie zu Beginn schon erwähnt, wird ab einer Anzahl von vier Überschriften automatisch ein Inhaltsverzeichnis erzeugt. Manchmal sind die Abschnitte jedoch so klein und unbedeutend, dass man sie nicht im Inhaltsverzeichnis mit aufführen, aber dennoch im Text hervorheben möchte. Andernfalls würde das Inhaltsverzeichnis zu überfüllt und unübersichtlich werden.

Um nun einen solchen Abschnitt dennoch hervorzuheben, bietet es sich an, dessen Überschrift durch Fettschrift zu markieren und als eigenen Absatz, das heißt mit Leerzeilen vom Text getrennt, zu schreiben. Eine weitere Möglichkeit, zum Beispiel zur Erklärung einzelner Begriffe, ist die Kombination von Fettschrift und Einrückungen durch den Doppelpunkt, wie das folgende Beispiel zeigt. Die Syntax:

'''Begriff 1'''
: Erklärung 1
''' Begriff 2'''
: Erklärung 2

ergibt

Begriff 1

Erklärung 1

Begriff 2

Erklärung 2

Durch diese Formatierung ist eine übersichtliche Gliederung möglich, ohne dass diese im Inhaltsverzeichnis erscheint und dieses überfüllt.

Wichtige Anmerkungen

Zum Abschluss dieses Abschnitts wollen wir dir noch ein paar wichtige Informationen zum Umgang mit Überschriften mit auf den Weg geben.

Im Abschnitt Links haben wir dir bereits gezeigt, wie man mit Hilfe der Raute # direkt zu einem Abschnitt springen kann. Überschriften erzeugen also automatisch einen Anker, auf den man verlinken kann.

Des Weiteren solltest du beachten, in Überschriften keine Formatierung zu verwenden, wie Kursivschrift oder Fettschrift. Auch sollten unnötige Satzzeichen, wie zum Beispiel der Doppelpunkt vermieden werden, denn viele dieser Formatierungen übertragen sich auf das Inhaltsverzeichnis, was dieses wiederum unübersichtlicher macht. Außerdem sollte eine Überschrift keinen Link enthalten. Ganz besonders ist darauf zu achten, dass Überschriften nicht mit Referenzen versehen werden. Möchte man den kompletten Abschnitt mit einem Einzelnachweis versehen, sollte man ihn anders in diesem Abschnitt unterbringen, denn wird die Referenz in der Überschrift gesetzt, so erscheint diese auch im Inhaltsverzeichnis. Dies sieht nicht gut aus und ist zudem auch noch überflüssig. Des Weiteren kann es sein, dass ein Abschnitt zu einem späteren Zeitpunkt um Informationen ergänzt wird, auf die sich die Referenz nicht mehr bezieht.