X2X

Problemstellung

Viele Nutzer stehen vor dem Problem, Lehrmaterialien oder umfangreichere Dokumentationen herstellen zu müssen. Der herkömmliche Weg besteht darin, mit einer Textverarbeitung oder einem Textsatzsystem den gewünschten Text zu verfassen. Für klassische Dokumente ist das auch ein angemessener Ansatz. Allerdings scheitert dieser, wenn man die Informationen im WWW bereitstellen möchte. Das hat verschiedene Gründe:

Die Export-Funktion der Werkzeuge erstellt lediglich ein Abbild der Papier-Version. Im WWW gelten aber andere Gestaltungsregeln.
Die erzeugten Dateien sind sehr stark an die Software des jeweiligen Werkzeugherstellers angelehnt. Entweder benötigt man einen Spezialbetrachter oder findet - selbst bei Verwendung von HTML - nicht überall lesbaren Code vor.
Wird vom Werkzeug versucht, eine möglichst breite Basis an verschiedenen Ausgabemedien zu unterstützen, so kann es im Extremfall passieren, dass auf jegliche Formatierung und Strukturierung verzichtet wird.

An ein neues Werkzeug werden noch weitere Anforderungen gestellt:

Der Autor sollte nicht mit Formatierungsdetails belästigt werden. Um dies zu erreichen, wird oft mit der endgültigen Darstellungsform gearbeitet (WYSIWYG). Jedoch kann so der Stil nicht immer konsequent eingehalten werden, wenn zu viel manuelle Formatierungen eingesetzt werden.
Herstellerabhängige Formate sind ungeeignet, wenn die Daten zwischen verschiedenen Werkzeugen ausgetauscht werden sollen. Das Werkzeug muss daher mit einem offenen Datenformat arbeiten.
Materialien sollen arbeitsteilig erstellt werden. Die Arbeitsteilung soll sowohl horizontal als auch vertikal möglich sein. Verschiedene Spezialisten könnten verschiedene Themengebiete (inhaltlich und gestalterisch) ausfüllen, um so eine höhere Gesamtqualität zu erreichen.

Beschreibung der Materialien

Ausgehend von diesen Anforderungen wurde an der Professur für Rechnernetze und verteilte Systeme ein Werkzeug entwickelt. Man hat sich für ein Datenformat auf XML-Basis entschieden, da die zu erzeugenden Texte zwar komplex, aber trotzdem gut strukturiert sind.

XML selbst ist kein fertiges Datenformat, wie oft vermutet, sondern lediglich die Definition, wie man Daten strukturiert abspeichert. Mit sogenannten Tags wird dabei ein Text in Abschnitte gegliedert. Tags treten (fast) immer paarweise auf. Ein öffnendes Tag beginnt den Abschnitt und ein schließendes Tag beendet diesen. In etwa so: <Name>Dieser Tag enthält einen Namen</Name>. Dabei können die Abschnitte ineinander verschachtelt werden.

Der XML-Stil für die Dokumente, die x2x verwendet, umfasst im wesentlichen alle HTML-Tags. Zusätzlich wurden noch vier Gruppen definiert, die zur Strukturierung und Gestaltung der Materialien dienen. Deren Beschreibung ist in der Online-Dokumentation nachzulesen und soll daher hier nicht weiter detailliert werden.

Ein Beispiel soll jedoch die Einfachheit und Vielseitigkeit verdeutlichen:

<section title="Routenermittlung">
Mit der <term>Record-Route-Option</term> (<type>ping -R</type>) ...
...

<example>
traceroute to www.uibk.ac.at (138.232.5.51), 30 hops max, 40 byte packets
 1  agsplus1.hrz.tu-chemnitz.de (134.109.200.254)  3 ms  2 ms  2 ms
</example>

<example class="syntax">
traceroute <ms>[</ms> <i>Optionen</i> <ms>]</ms>
</example>

<question>
Wieso kann ein Router mehrfach in der traceroute-Ausgabe auftreten?
</question>

<discussion>
Versuchen Sie, weitere "interessante" Routen zu finden, 
d.h. solche, die einen anderen Weg als vermutet nehmen.
</discussion>

</section>

Das Werkzeug

Da es nicht zu erwarten ist, dass es jemals spezielle Anzeigeprogramme für diesen XML-Stil geben wird, müssen die Daten in ein anderes Format umgewandelt werden. Derzeit sind als mögliche Ausgabeformate HTML und L^AT_EX verwendbar.

Das Werkzeug ist modular aufgebaut und ermöglicht so eine sehr schnelle Anpassung an individuelle Bedürfnisse.

Systemaufbau

Im Funktionskern (Core) ist die Infrastruktur des Programmes untergebracht. Dieser Teil ist für die Steuerung der Konvertierung zuständig.
Die Generierung der Ausgabe wird von den sogenannten Styles übernommen. In diesen wird für jeden XML-Tag beschrieben, was für diesen generiert werden soll, wenn er im Quellcode auftritt.
Der Nutzer kann für den Konvertierungsvorgang eine Reihe von Optionen auswählen. Außerdem ist es von erfahrenen Nutzern gewünscht worden, eigene Tags zu definieren oder bestehende Umsetzungen abzuändern. Dies ist mit den Config-Dateien möglich.

Das Werkzeug wurde komplett in der Scriptsprache TCL geschrieben. Auch für die Beschreibung der Styles und der Konfigurationen wird diese Sprache benutzt, wodurch eine sehr hohe Flexibiliät bei der Erweiterbarkeit und Modifizierbarkeit erreicht wird.

Praxis

Das Werkzeug wird seit etwa einem Jahr für das in Zusammenarbeit mit dem VDE durchgeführte "Internetstudium" eingesetzt. Ein schönes Beispiel einer HTML-Ausgabe findet man unter: http://iuk.tu-chemnitz.de./iall/ib/.

Auch die Kursunterlagen zum Java-Kurs im URZ (http://www.tu-chemnitz.de/urz/java/kurs2000/, die Lehrmaterialien zum Zertifikat Internet-Nutzung (http://www.tu-chemnitz.de/urz/ZIN/lehre/) und verschiedene Vorlesungsskripte an der Professur für Rechnernetze und verteilte Systeme wurden mit dem Werkzeug erstellt.

Das Werkzeug und die dazugehörige Dokumentation ist im AFS in diesem Verzeichnis zu finden: /afs/tucz/home/urz/h/huebner/tuconly/x2x/.

Chris Hübsch, 18.07.2000