Hilfe:ArtikelStrukturieren


Aus Macwrench

(Weitergeleitet von Hilfe:Artikelstruktur)
Wechseln zu: Navigation, Suche
HelpDocument.png
  Help.png Hilfe
 

Inhaltsverzeichnis

Strukturieren von Artikeln

Artikel werden in erster Linie über die Überschriften strukturiert, was auch erst das automatische Erzeugen des Inhaltsverzeichnisses im Seitenkopf ermöglicht:

Jeder Artikel sollte daher mit Hilfe von Überschriften strukturiert werden. Ab einer Anzahl von 3 wird dadurch automatisch im Artikelkopf ein Inhaltsverzeichnis erzeugt, was sich jedoch in den Benutzereinstellungen unter dem Reiter "Verschiedene Einstellungen" deaktivieren lässt:

Hilfe PreferencesTOC.png

Hinweis: Es sollten keine Überschriften der ersten Ebene (also z.B. =Artikelname=) erstellt werden, diese werden durch das Wiki automatischerzeugt.

Wichtigkeit von Überschriften

Nicht nur bei umfangreichen Artikeln ist es absolut unerlässlich, von der struktierenden Eigenschaft der Überschriften Gebrauch zu machen. Dabei sollte ein Artikel keine Überschriften der 1. Ebene verwenden, da diese bereits für den Artikelnamen im Artikelkopf (vom Wiki automatisch erzeuget) verwendet werden und den Artikel unübersichtlich werden lassen.

Dabei ist noch zu bemerken, dass das Inhaltsverzeichnis immer direkt oberhalb der ersten Überschrift platziert wird. Dies bietet die Möglichkeit, einen kleinen einführenden Text vor dieser Überschrift einzufügen, der dadurch ideal als Vorwort dem Leser direkt ins Auge springt und den Inhalt des Artikels leicht erfassbar und in wenigen Sätzen wiedergeben sollte.

Überschriften erzeugen

Die erste Überschrift eines Artikels beginnt also mit einer Überschrift der 2. Ebene: ==Überschrift 2. Ebene==

===Überschrift 3. Ebene===

(1. Ebene ist der Titel des Artikels)

Text um 1 Tabulator einrücken mit : voranstellen
Text um 2 Tabulatoren einrücken mit :: voranstellen

Trennlinien

Mit Hilfe von Trennlinien können kleine Einschübe optisch vom Rest abgehoben werden. Trennlinien haben dabei keinen Einfluß auf die Strukturierung des Artikels hinsichtlich des Inhaltsverzeichnisses, sollten dennoch nur sparsam eingesetzt werden.

Die folgende Zeichenfolge

----

erzeugt dabei eine solche horizontale Trennlinie über die gesamte Breite:


Artikelnavigation anpassen

Durch Schlüsselwörter kann die Anzeige verschieder Navigationselemente angepasst werden:

Inhaltsverzeichnis erzwingen

Falls in einem relativ langen Artikel sehr wenig Überschriften existieren, kann man durch Eingabe dieses Schlüsselwortes:

__FORCETOC__

die Anzeige erzwingen (am Besten ganz am Anfang oder ganz am Schluss).

Inhaltsverzeichnis verbergen

Analog dazu kann man in Artikeln die Anzeige des Inhaltsverzeichnisses verhindern, in dem man dieses Schlüsselwort in den Wiki-Text einfügt (am Besten ganz am Anfang oder ganz am Schluss):

__NOTOC__

Bearbeiten-Knöpfe verbergen

Üblicherweise werden in jedem Abschnitt eigene "Bearbeiten" Knöpfe angezeigt, um einzelne Abschnitte bearbeiten zu können (siehe Hilfeartikel "Artikel Bearbeiten"). Deren Anzeige kann durch die Angabe dieses Schlüsselwortes im Wiki-Text (am Besten ganz am Anfang oder ganz am Schluss) unterbunden werden

__NOEDITSECTION__
Persönliche Werkzeuge