copyright (c)  2003   usegroup
docuML

Jochen Staerk
docuML
Was ist docuML?

nach untenWas ist DocuML
nach untenAnwendungsbeispiele
nach untenWoraus besteht DocuML
nach untenVersion

Was ist DocuML

nach obenWas ist DocuML 

docuML ist ein XML-Format, um Dokumentationen zu schreiben. Diese Dokumnetationen erhalten durch die docuML-Transformation ein Inhaltsverzeichnis, ggf. ein Stichwortverzeichnis, ein einheitliches Aussehen, eine Navigation zwischen den Dateien und die sonst notwendigen HTML-Tags. Die Ausgabe erfolgt also in HTML (genauer:xhtml).

Im Gegensatz zu docbook/XML ist docuML sehr leichtgewichtig, also auch leichter zu lernen, und aufgrund der Beschränkung auf HTML-Ausgabe können auch HTML-Tags verwendet werden (nicht nur im eigenen Namespace, sondern auch direkt eingebunden).


Anwendungsbeispiele

nach obenAnwendungsbeispiele 

Das PHP-Tutorial

und zum Beispiel das XML/XSLT-Tutorial sind in docuML geschrieben. Sie sehen sich sehr ähnlich, aber gerade die "zentrale Lagerung" des Designs in der Transformation ist ungemein nützlich: Wenn Sie diese Transformation anpassen (was Sie durchaus können und sollen), beispielsweise einige Farbwerte anpassen, können Sie sie auf jedes docuML-Projekt anwenden und jede Datei wird an entsprechender Stelle Ihre neuen Farben zeigen.


Woraus besteht DocuML

nach obenWoraus besteht DocuML 

docuML sind primär nur zwei XSLT-Transformationsdateien (documl.xsl und xhtmlxsl.xsl). Mit einem XSLT-Prozessor wie der Java-Anwendung Saxon können Sie Ihre docuML-Quelldateien kompilieren.

Zum Beispiel aufgrund des Integrierens der XHTML-Befehle ist es leider schwer, ein docuML-Schema zu erstellen.


Version

nach obenVersion 

Aktuelle Version von docuML ist 3.2, 30.07.2007. Ein kurzer Überblick über die Geschichte:

Version 1.0 Version 1.0 von DocuML nutzte noch keine XSL-Style-Sheets und wurde durch ein proprietäres Java-Programm eingebunden
Version 2.0 Ab Version 2.0 wurden SAXON als XSLT-Prozessor eingesetzt, das komplette XHTML 1.1 wird gekapselt und kann in den Dokumenten verwendet werden
Version 3.0 Version 3.0 lagerte alle Angaben zum Projekt aus der XSL-Datei in die bereits für Einstelungen benutzte Project.xml aus. Dadurch wird die XSL-Datei unabhängig vom übersetzten Dokument. Zusätzlich wurden erste Interaktionen eingeführt ( Multiple-Choice und Lückentext)
Version 3.1 In Version 3.1 wurden schließlich am 20.9.2003 inline-examples und news eingeführt.


copyright (c)  2003   usegroup