UDO-Handbuch wird umgestaltet
Ulf Dunkel
Ich bin momentan dabei, das UDO-Handbuch auf Vordermann zu bringen. Als
erstes habe ich jetzt die Sprachen aus den einzelnen .ui-Dateien in
separate .de- und .en-Dateien gelegt und noch ein bisschen mehr aufgeräumt.
Ich möchte in der nächsten Zeit das Handbuch noch weiter pflegen und die
Texte aktualisieren, aufräumen und die Übersetzungen voranbringen.
Ist hier jemand in der Liste, der z.B. nativ oder sehr gut eine andere
Sprache als Deutsch und Englisch spricht, um das UDO-Handbuch in weitere
Sprachen zu übersetzen?
Ihr findet die neu strukturierten Handbuch-UDO-Dateien im Repository ab
rev. 708. Die Struktur ist jetzt m.E. sauberer:
.u = UDO-Haupt-Datei
.ui = UDO-Include-Dateien, wobei gilt:
_<name>.ui = diese Dateien inkludieren _keine_ Sprachdateien
<name>.ui = diese Dateien inkludieren Sprachdateien
.de = deutsche Inhalte
.en = englische Inhalte
Ich habe im Befehl !html_name das explizit angegebene Dateisuffix .html
wieder entfernt, und zwar aus zwei Gründen:
1) UDO kann anhand des Dateisuffix der im -o-Command angegebenen
index-Datei das Dateisuffix automatisch erkennen und benutzen.
2) Auf dem Server, auf dem udo-open-source.org läuft, werden sowohl
.php- als auch .htm-Dateien, nicht aber .html-Dateien vom PHP-Parser
gelesen. So kann ich steuern, dass die .htm-Seiten, die jetzt erzeugt
werden, einen PHP-Header bekommen, damit das Encoding, das auf meinem
Server mittlerweile global auf "utf-8" eingestellt ist, noch in
"iso-8859-1" o.ä. eingestellt ist. (Auf Dauer sollte natürlich UDO auch
vernünftig mit UTF-8 umgehen können.
Zugleich habe ich einige Monsterdateien in kleinere Häppchen aufgeteilt,
da das Handling kleinerer Dateien wesentlich bequemer ist. Und ich habe
einige Kapitel etwas umbenannt, im Anhang die Reihenfolge der Kapitel
umgedreht und die versteckten Befehle-Kapitel im Inhaltsverzeichnis
sichtbar gemacht. Warum sollte man sie verstecken? Im Handbuch will man
ja schließlich was finden.
Was haltet ihr davon, das separate Handbuch "UDO - eine kleine
Einführung", das Tobias Jung 2001 geschrieben hat, mit in das
Haupt-Handbuch aufzunehmen, damit es alles "unter einem Dach" ist?
PS: Die aktuelle Version des Handbuchs, das sich komplett fehlerfrei für
HTML erzeugen lässt, ist schon online:
http://man.udo-open-source.org/de/
http://man.udo-open-source.org/en/
--
Ulf Dunkel