SELFHTML Weblog - Ergänzung zur Dokumentation Übersicht

Eine der zentralen Fragen der letzen Zeit, wenn es um SELFHTML ging, lautete: »Wie geht es weiter mit SELFHTML?«. Schon vor und erst recht nach dem wenig erfolgreichen Wiki-Versuch haben uns viele Unterstützer ihre Mitarbeit angeboten. Wir mussten diese Helfer bislang immer wieder mit »Danke! Wir geben Bescheid, sobald wir so weit sind.« vertrösten.

Nun – wir sind so weit!

Es mussten viele Arbeiten erledigt werden, bis wir »so weit« waren. Erst haben wir die Server umstrukturiert, danach folgte die Umgestaltung des Redaktionsbereichs erst mit Tests, dann mit dem Online-Gang von Trac (Version 0.10.4). Siehe auch: Was war ... Was wird ... hier im Blog.

Das war bei weitem nicht alles, was zuvor zu erledigen galt. Die Umstellung SELFHTMLs von HTML auf XML erforderte viele Tage Arbeit. In diesem Zusammenhang haben wir auch eine Layout-Ausschreibung veranstaltet, um den Nutzern die Möglichkeit zu bieten, das künftige Layout der Dokumentation aktiv mitzugestalten.

Ergebnis der Layout-Ausschreibung

An dieser Stelle möchten wir uns für die zahlreichen Wortmeldungen im Forum und für die Einreichungen zur Ausschreibung bedanken. Auch denjenigen möchten wir danken, die sich zwar nicht an der Ausschreibung beteiligten, aber ihre Vorschläge im Forum vorgestellt haben.

Jedes der eingesandten Layouts zeigt Ideen auf, die wir gerne für das Layout der Dokumentation übernehmen würden. Nach Besprechungen im Redaktionsforum und einer sehr intensiven Diskussion im Redaktionschat, die über drei Stunden dauerte, hat sich folgendes Bild herauskristallisiert:

Als Grundlage für das neue Layout werden wir Marcel Scherkamps Vorschlag nutzen und diesen um entsprechend adaptierte Ideen aus anderen Vorschlägen ergänzen bzw. erweitern.

Wie geht es nun weiter?

Wie schon erwähnt, dauerte die Umstellung von SELFHTML von HTML auf XML eine Weile. Die in das neue XML-Format konvertierte Version von SELFHTML ist mittlerweile in das SVN-Repository eingecheckt. Auch auf die Frage, wie Redakteure mit diesem XML-Format – auch ohne Kenntnisse von XML – arbeiten können, haben wir eine Antwort in Form des XMLmind Editors gefunden. Redakteuren und auch anderen Interessierten steht ein an SDML (das XML-Format für SELFHTML) angepasster Editor zur Verfügung. Wer sich etwas ausführlicher über SDML informieren möchte, ist eingeladen, die dazugehörige Informationsseite zu besuchen.

Der Konverter, den Christian Seiler geschrieben hat, leistete hervorragende Arbeit. Alle XML-Dateien valideren gegen die DTD. Dennoch konnten angesichts des Umfangs von SELFHTML nicht alle Individualitäten oder Fehler des HTML-Quellcodes restlos bei der Konvertierung beseitigt werden. Daher zählt zu den ersten Arbeiten mit dem neuen Format die Aufgabe, die nach der Konvertierung noch vorhandenen Fehler auszubessern. Nach diesem wichtigen Teil kann die »ganz normale« Autoren-Schreibarbeit beginnen.

Die Doku im neuen Layout?

Auf die Frage: »Wann kann man die Dokumentation im neuen Layout betrachten?« gibt es zur Zeit nur die Antwort: »Sobald sie so weit ist.« Aktuell arbeiten wir daran, es den Redakteuren zu ermöglich, die Dokumentation online zu betrachten. Dazu dient ein Servlet, das die XMLs mittels XSLT transformiert. Es existieren zwei Gründe, weshalb diese Möglichkeit einstweilen nur Redakteuren zugänglich bleibt. Erstens ist die Generierung von großen, automatisch erstellten Seiten, wie z.B. dem Stichwort- oder Syntaxverzeichnis speicherintensiv, da dazu alle XML-Dateien in einem Vorgang eingelesen und ausgewertet werden müssen. Zweitens gibt es zur Zeit nur ein sehr rudimentäres Layout, das nur minimales HTML und CSS aufweist. Erst jetzt, nach der Layout-Auschreibung kann damit begonnen werden, die Vorschläge und Ideen in das XSLT zu übertragen. Geplant haben wir dennoch, ab einem späteren Zeitpunkt in regelmäßigen Abständen sogenannte Snap-Shots oder »Momentaufnahmen« des Entwicklungsstandes als HTML zu generieren und online zu stellen.