Wiki

Ein paar allgemeine Hinweise zum Wiki.

mitgelieferte Dokumentation

Die nachfolgend aufgelisteten Seiten gehören zu jeder Installation von Dokuwiki:

Rund ums DokuWiki (en)

Einführung in die Wiki-Syntax (en)

Erste Schritte und wichtige Hinweise

Für denjenigen, der sich noch nicht intensiv mit dem Wiki (und insbesondere dokuwiki) beschäftigt hat, nachfolgend ein paar kurze Hinweise.

Technische Aspekte von Interesse

Die technischen Aspekte sind auch für denjenigen von Interesse, der sonst kein Interesse an den technischen Hintergründen des dokuwikis hat. Sie führen nämlich idealerweise zu einem besseren Verständnis einiger weiter unten genannter praktischer Aspekte.

Alle Seiten werden als reine Textseiten abgelegt.

Die Verzeichnisse in der URL („Namensräume“) entsprechen realen Verzeichnissen auf dem Dateisystem.

Zu jedem Namensraum wird bei Bedarf automatisch ein gleichlautendes Verzeichnis für die Medien (hochgeladene Dateien, also Bilder, PDF-Dokumente, etc.) angelegt.

Die Frage, ob man eine Seite oder einen ganzen Namensraum anlegt, hängt also auch davon ab, wie viele Medien-Dateien potentiell zu dieser Seite hinzukommen werden.

Eine DokuWiki-Installation läßt sich sehr einfach umziehen, kopieren, synchronisieren oder davon ein Backup erstellen, indem man einfach das Datenverzeichnis (data) kopiert/synchronisiert, das sowohl die Seiten als auch die zugehörigen Medien enthält.

Größere Verschiebungsorgien von ganzen Namensräumen lassen sich, einen entsprechenden Dateisystemzugriff vorausgesetzt, sehr bequem durchführen. Dafür sollten allerdings ein paar praktische Aspekte (s.u., insbesondere die Verwendung relativer statt absoluter Links für Medien wie Bilder) beachtet werden.

Praktische Aspekte

Sicherlich ist jeder frei, zu tun und zu lassen, was ihm beliebt, schon gar im eigenen Wiki. Trotzdem gibt es eine Reihe von Aspekten, die für einen sauberen Quelltext, damit eine bessere Lesbarkeit, und vor allem für Konsistenz und einfache spätere Änderungen sorgen und daher beherzigt werden sollten.

Jede Seite beginnt mit einer Überschrift erster Ordnung (H1), die gleichzeitig als Titel verwendet wird.

Es gibt auf jeder Seite genau eine Überschrift erster Ordnung (H1). Alle nachfolgenden Überschriften sind zweiter Ordnung (H2) oder kleiner (H3…H5).

Medien bitte nach Möglichkeit immer mit relativem Pfad einbinden, nicht mit absolutem Pfad.

Das ist insbesondere vor dem Hintergrund einer Umorganisation von Teilen des Wikis interessant, da man so recht einfach ganze Verzeichnisse im Dateisystem verschieben kann und die Links erhalten bleiben.

Bilder (und Tabellen) nach Möglichkeit mit Unter- bzw. Überschriften („caption“) versehen. Dazu gibt es das caption-Plugin mit entsprechender Syntax: <figure>…<caption></caption></figure> bzw. <table><caption></caption>…</table>.

Absätze werden durch Einfügen einer Leerzeile im Quelltext erzeugt. Der harte Zeilenumbruch über \\ sollte nur in speziellen Fällen verwendet werden.