Vorgaben für Wiki-Autoren

Vorgaben für Wiki-Autoren

Damit sich der Leser auf den Wiki-Seiten gut und schnell zurechtfindet, sind einige Dinge zu beachten, welche die Orientierung auf der Seite und innerhalb des Artikels begünstigen. Hierzu zählt, dass die Artikel wie aus einem Guss wirken und sich an gleiche Konventionen und Notationen halten. Dies erleichtert auch die Arbeit an den Artikeln, wenn diese von verschiedenen Autoren bearbeitet werden.

Inhalt und Layout

Artikel sollen nicht auf andere Unterseiten verlinken, also nicht künstlich zergliedert werden. Verlinkungen sorgen dafür, dass der Leser die Orientierung verliert. Dies ist auch der Grund, weshalb moderne Internetseiten von verschachtelten Menüs absehen und auf ein One-Page-Design setzen. Der Wiki-Leser soll aus der Artikelübersicht einen Artikel aufrufen können um anschließend mit dem Back-Button des Browsers wieder in die Übersicht zurückkehren zu können. Ein Artikel soll alle relevanten Informationen enthalten, so dass man diese Informationen auch in einem Rutsch lesen und drucken drucken kann.

Der Artikel sollen für einen unerfahrenen Benutzer geschrieben sein. Es ist immer davon auszugehen, dass der Leser die Wiki-Seite aufsucht, weil er sich noch nicht mit der gesuchten Thematik auskennt. Folglich sollten die Informationen vollständig und ausführlich sein.

Tabellenstrukturen sollen vermieden werden, da sie den Browser daran hindern, eine Geräteunabhängige Anzeige zu erstellen. Es sollen nur Formatierungen verwendet werden, welche das Mediawiki anbietet. Hierdurch werden HTML-Tags vermieden, wodurch die Überarbeitung eines Artikels durch andere Autoren erleichtert wird.

Einbinden von Bildern und Dateien

Eingebundene Bilder sollen logisch benannt werden. Bei der Benennung ist darauf zu achten, dass keine Sonderzeichen oder Umlaute genutzt werden. Der Name der Bilddatei sollte alle wesentlichen Informationen enthalten. So sollte z.B. ein Bild zur Erläuterung einer Menüfunktion nach folgendem Schema benannt sein:

Programm_Reitername_Menuename_Bildname.png

Beispiel: Schild_Verwaltung_Import_Auswahlfenster.png

Das bevorzugte Bildformat von Screenshots sollte png sein, da es die beste Kompression für Screenshots bietet. Die Bilder sollten als Bildvorschau (Thumbnail) rechts im Fließtext so eingebunden werden, dass die Größe ausreicht, Informationen zu erkennen. Erst ein Klick auf das Bild führt zu einer Vergrößerung. Die Bilder Vorschaubilder sollen einen Rahmen und einen Untertitel tragen.

Verwenden von Kategorien

Die Wiki-Artikel sollen Kategorisiert werden. Damit lassen sich mit Hilfe der Kategorie-Übersichtseiten relevante Artikel schneller finden. Ein Artikel kann mehreren Kategorien angehören. So kann ein Artikel die Kategorien "SchILD-NRW", "Karteireiter Verwaltung" und "Import" haben. Ein Artikel wird Kategoriesiert, indem ein Kategorie-Tag oder mehrere Kategorie-Tags am Ende des Artikels angefügt werden. Die Kategorie "SchILD-NRW" wird zum Beispiel durch den Tag [[Kategorie:SchILD-NRW]] zugeordnet. Wird ein Kategorie-Tag benutzt, für den es noch keine Kategorie gibt, legt das Mediawiki automatisch eine Kategorie an. Bei der Verwendung der Kategorien ist unbedingt auf Groß- und Kleinschreibung zu achten, ansonsten werden unterschiedliche Kategorien angelegt. Eine Übersicht über alle schon verwendeten Kategorien findet man unter dem Menüpunkt Spezialseiten > Rubrik Seitenlisten > Kategorien.

Verwenden von Vorlagen

Manchmal möchte man in einem Artikel einen farblich hervorgehobenen Hinweis oder ähnliches geben. Hierzu gibt es einige Vorlagen, von denen gerne Gebrauch gemacht werden soll. Eine Übersicht über die Vorhandenen Vorlagen findet man unter dem Menüpunkt Spezialseiten > Rubrik Seitenlisten > Kategorien > Vorlage.

Typische Inhaltsbausteine

Der Inhalt dieses Abschnitts verwendet die typischen Layoutbausteine, die in einem Artikel verwendet werden. Er dient dem Wiki-Autor als Referenz, welche Befehle in der Auszeichnungssprache gesetzt wurden, damit ein Effekt realisiert werden kann. Wer sich tiefer in die Materie einlesen möchte, findet am Ende dieses Abschnittes weiterführende Links zu Hilfeseiten der Wikimedia Foundation.

Layout

Dies ist ein fett geschriebener Text. Dies ist ein kursiv geschriebener text. Dies ist ein fett und kursiv geschriebener Text.

Hier wird eine horizantale Linie erzeugt.

---

Dies ist der Text unterhalb der horizontalen Linie

Hier startet eine Auflistung mit Aufzählungszeichen:

• Erster Punkt
• Zweiter Punkt
  • Erster Unterpunkt
  • Zweiter Unterpunkt
    • Erster Unter-Unterpunkt
    • Zweiter Unter-Unterpunkt
• Dritter Punkt

Hier startet eine nummerierte Liste:

1. Erster Listenpunkt
2. Zweiter Listenpunkt
   1. Erster Unterlistenpunkt
   2. Zweiter Unterlistenpunkt
      1. Erster Unter-Unterlistenpunkt
      2. Zweiter Unter-Unterlistenpunkt
3. Dritter Listenpunkt

So kann man Text einrücken, was jedoch vermieden werden sollte:

Einfache Einrückung

Doppelte Einrückung

Mehrfache Einrückung

In Zusammenhang mit einer Definitionsliste können Einrückungen jedoch sinnvoll sein:

Begriff 1

Beschreibung 1

Begriff 2

Beschreibung 2-1

Beschreibung 2-2

Verschiedene Listentypen können auch gemischt verwendet werden:

1. Erster Listenpunkt
2. Zweiter Listenpunkt
   • Erster Unterpunkt
   • Zweiter Unterpunkt
3. Dritter Listenpunkt

Beginnt ein Text in einer Zeile mit einem Leerzeichen, so wird ein vorformatierter Textblock erzeugt. Dieser sieht dann so aus. Innerhalb des Textblockes können andere Layoutfunktionen wie Fettschrift aufgerufen werden.

Manchmal möchte man in einem solchen vorformatierten Textblock Code einfügen, der unverändert angezeigt werden soll. Hierzu beginnt der Absatz wieder mit einem Leerzeichen. Der Folgetext wird zwischen das <nowiki>-Tag eingeklammer. Dadurch wird der Folgetext unverändert angezeigt.

     Dies gilt auch für Einrückungen und

Trennzeilen und eignet sich damit hervorragend für die Darstellung von Programmcode.

Komplett '''vorformatiert'''Text wird in dem <pre>-Tag eingeklammert. Innerhalb dieses Tags haben ''Markups'' keine Funktion. Auch dieser Kontainer bietet sich somit sehr gut für die Darstellung von Programmcode an.

Manchmal möchte man Code darstellen, der nicht umgebrochen werden soll, aber zu lange für die Seitenbreite ist. Hier bietet sich ein vorformatierter textkasten an, welcher nicht automatisch umbricht und einen Scrollbalken erhält.

Innerhalb eines Fließtextes kann man Quelltext als hervorgehobenen Code anzeigen.

Diesem Text folgt ein Kommentar, welcher natürlich nur in der Bearbeitungsbereich sichtbar ist.

Ein Absatz wird dadurch erzeugt, dass eine Zeile frei gelassen wird. Wird keine Zeile frei gelassen, behandelt Mediawiki den Text so, als wäre er ohne Absatz geschrieben.

Bilder

Ein rechtsbündiges Bild leicht verkleinert als Vorschaubild

Bilder können leicht eingefügt werden. Hierzu muss zunächst die Bilddatei vernünftig benannt (s.o.) und in das Mediawiki hochgeladen werden. Von nun an kann es leicht eingebunden werden. Der den Aufruf als "thumb" wird das Bild rechtsbündig als Vorschaubild angezeigt.

Ein rechtsbündiges Bild leicht verkleinert als Vorschaubild

Mit dem Aufruf "hochkant=0.7" oder "210px" kann das Vorschaubild in der Größe angepasst werden. Hochkant benutzt relative Angaben, die Pixelangaben sind absolut. Das Bild wird vor dem Text eingefügt, der links daneben angezeigt werden soll. Wenn ein Absatz nach dem Bild geschrieben werden soll, so muss vor dem Absatz ein "clear-Befehl gesetzt werden"

Links

Interne Links werden in Doppelte Eckige Klammern gesetzt. Dies ist ein Link auf diese Seite: Vorgaben für Wiki-Autoren.

Der angezeigte Linktext für interne Links kann angepasst werden. Dies ist ein Link auf diese Seite mit angepasstem Text: Vorgabe.

Es kann auch auf eine Überschrift innerhalb des Artikels verlinkt werden. Dieser Link verweist zur Überschrift Inhalt und Layout innerhalb dieses Artikels.

Auch auf Überschriften anderer interner Artikel kann verlinkt werden. Dies ist ein vollständiger Link auf diesen Artikel und die Überschrift Inhalt und Layout.