Das simple Wiki für den Hausgebrauch

Selbstdokumentation ist nicht nur eine Tugend, sondern eine Notwendigkeit. Zumindest wenn man, wie ich, ein eigenes Blog betreibt und in seinem Haushalt eine gewisse technische Infrastruktur verwendet, die nicht von der Stange ist. Es kann nämlich sein, dass man sich nach Monaten oder Jahren daran erinnern sollte, welche Hacks man in die Themes-Dateien des Blog eingebaut hat, warum man diesen oder jenen Port in der Router-Firewall öffnen musste, wie man seinen Raspberry-Pi konfiguriert hat. Und so weiter.

Bis anhin habe ich das über eine Art Intranet gemacht, die aus einer Handvoll HTML-Dateien besteht. Die habe ich entweder direkt oder über einen HTML-Editor (früher GoLive, heute Dreamweaver) bearbeitet. Das war vor 15 Jahren, als ich damit angefangen habe, eine fancy Lösung. Aus heutiger Sicht viel zu umständlich: Man will seine Infos direkt im Browser editieren können.

Eine Wissensdatenbank, ganz ohne Server und Webspace

Entsprechend kam mir die Empfehlung von @JanRo gerade gelegen: tiddlywiki.com ist ein simples Wiki, das ohne Server-Software auskommt. Es besteht aus einer einzigen HTML-Datei und speichert die eingegebenen Daten per JavaScript direkt in dieser Datei – die man entsprechend offline oder via Netzlaufwerk benutzen und zwischen Laptop und Desktop-Computer hin und her kopieren kann. Damit die Änderungen in die Datei geschrieben werden können, benötigt man die Tiddlywiki-Erweiterung für Firefox.

Da alles in einer Datei landet, arbeitet man nicht mit Seiten, sondern mit so genannten Tiddlern – was so viel heisst wie kleines Ding. Wikipedia bemerkt in seinem Beitrag natürlich zu Recht, dass dieser Trick mit den Tiddlern und der Speicherung in einer einzigen Datei gewisse Limiten mit sich bringt und dazu führt, dass man das Wiki nur für überschaubare Projekte verwenden sollte.

Für Tausende Seiten wenig geeignet

Wenn man davon ausgehen muss, Hunderte oder Tausende Seiten zu benötigen, dann sollte man eine Lösung wählen, die entsprechend skaliert, beispielsweise Wikia oder eine der anderen hier aufgelisteten Wiki-Varianten.

Für den Hausgebrauch reicht Tiddlywiki aber allemal. Nach dem Herunterladen kopiert man die HTML-Datei in den gewünschten Ordner und öffnet sie in Firefox. Es erscheint die Startseite GettingStarted, die man über das Bleistift-Symbol rechts oben editiert. Über das Kreuz-Symbol schliesst man den Tiddler und per i-Symbol sieht man seine Eigenschaften wie Tags, Listen und verweisende Links ein.

Die Tiddler verwalten

Am rechten Rand gibt es eine (über das Menü-Symbol ganz rechts oben ein- und ausblendbare) Navigationsleiste. Sie stellt ein Plus-Symbol zur Verfügung, über das man neue Tiddler einrichtet. Über den Knopf mit dem nach unten zeigenden Pfeil lädt man das Wiki herunter und das Zahnrad-Symbol führt zum Control Panel.

In diesem Control Panel benennt man sein Wiki, wählt den Tiddler, der standardmässig geöffnet werden soll und kann auch diverse andere Einstellungen treffen: Beispielsweise bezüglich der Layouts und der automatischen Speicherung. Das Wiki kann für sensible Daten verschlüsselt werden und es ist über Tools möglich, Seiten zu importieren und zu exportieren. Beim Import holt man eine bestehende Datei ins Wiki herein. Ich habe die Funktion benutzt, um die Startseite meines alten Intranets einzubetten, sodass ich ohne Weiteres zu den alten Informationen gelange.

Notfalls verwandelt man sein Wiki in eine ganz normale Website

Bei Tools findet sich auch der Befehl Download all tiddlers as static HTML. Mit ihm lassen sich alle Tiddler als normale HTML-Seiten exportieren, die ohne Javascript auskommen und in eine herkömmliche Site integriert werden könnten. Die Weiterverwendung der Informationen ausserhalb von Tiddlywiki ist also gewährleistet.

Über die Navigationsleiste kann man suchen und die weiteren Funktionen nutzen: Die Übersicht aller offenen Tiddler und der kürzlich editierten Tiddler. Via Tools erhält man Schnellzugriff auf die Importfunktion und einige Ansichts-Einstellungen. und bei More findet sich ein Tag-Manager, über den man seine Seiten verschlagwortet. Es gibt hier auch die Möglichkeit alle Seiten aufzurufen und die Entwürfe zu verwalten. Der Eintrag Orphans führt zu verwaisten, d.h. nicht verlinkten Seiten.

Ein Pferdefuss hat die Sache natürlich: Bei der Bearbeitung verwendet man die Wiki-Syntax (WikiText genannt). Die funktioniert ähnlich wie die in diesem Blog auch schon vorgestellte MarkDown-Sprache. Die ist jedoch einfach zu erlernen – und wenn man sie eh schon kennt, umso besser.

Auch in Deutsch zu haben

Einige allgemeine Bemerkungen:

• Eine deutsche Version von Tiddlywiki gibt es auf karadeniz.de.
• Es gibt das Wiki in einer neuen, HTML5-kompatiblen Version (TiddlyWiki5) und in einer älteren, klassischen Version ohne HTML5-Features. Welche man verwendet, ist Geschmackssache. Ich habe auf die neue Version gesetzt. Die Besprechung in diesem Blogpost bezieht sich auf diese Version. Wenn man die neue Version benutzt, bedeutet das, dass einige Plugins und die deutsche Übersetzung nicht benutzt werden können, weil sie (noch) nicht verfügbar sind.

Einige Tipps zur Formatierung:

• Links stehen zwischen zwei eckigen Klammern [[Link]]. Will man den Verweis benennen, verwendet man erst den Verweis, dann den Link und trennt das mit dem senkrechten Strich: [[Mein Blog|http://www.clickomania.ch]]
• Bilder werden per Drag&Drop ins Wiki gezogen und werden wie folgt platziert: [img[MeineGrafik.jpg]]
• Titel werden mit !, !!, !!! ausgezeichnet: !Haupttitel.
• Fürs Aufzählungszeichen setzt man *, für eine nummerierte Liste #.
• Fett wirds zwei Apostrophen vorn und hinten, kursiv mit zwei Schrägstrichen: ‘’bold’’ und //italic//
• Über die Option Show Preview bzw. Hide Preview schaltet man während der Bearbeitung eines Tiddlers die Live-Voransicht ein und aus.

Einige Tipps zur Bearbeitung und Konfiguration:

• Bei der Bearbeitung eines Tiddlers bestimmt man am Fuss bei Typ den Inhalt. Setzt man dort die Option text/html, kann man anstelle von WikiText auch ganz normalen HTML-Code verwenden. Mit Plan Text ist auch unformatierter Text möglich.
• Tiddlywiki kann auch durch Plugins erweitert werden. Wie man die installiert, ist unter tiddlywikiguides.org beschrieben. Man macht, kurz zusammengefasst, einen neuen Tiddler. Diesen benennt man mit dem Namen des Plugins und fügt den Code ein, den man auf einer Website gefunden hat. Dann vergibt man den Tag systemConfig, speichert und lädt die seine Tiddlywiki-HTML-Seite neu. Man muss bei den Plugins darauf achten, für welche Core-Version sie entwickelt wurden. Wenn man TiddlyWiki5 (Version 5.0) für HTML5 nutzt, dann sind Plug-Ins für die alte Version wahrscheinlich nicht kompatibel.
• Tiddlywiki versucht, Links automatisch zu erkennen. Das ist in Deutsch etwas mühsam, das Wörter mit Bindestrich automatisch als Link erkannt werden. Es lässt sich verhindern, indem man die Tilde ~ voranstellt. Über die Erweiterung DisableWikiLinksPlugin kann man diese Funktion bei Classic-Tiddlywiki auch komplett abschalten.

Fazit: Eine nützliche Sache, denn die wichtige Selbstdokumentation betreibt man nur dann, wenn sie mit maximaler Einfachheit möglich ist.