Home Inhaltsverzeichnis Home UDO im Allgemeinen
 UDO - Eine kleine Einführung

1 UDO - Das Werkzeug für universelle Dokumente

In diesem Text möchte ich einige grundlegende Funktionen von UDO vorstellen und gleichzeitig eine kleine Einführung in die UDO-Syntax geben. Er dient allerdings nicht als Ersatz für die Anleitung, die dem Programm beiliegt - im Gegenteil verweise ich sogar mehrfach auf die ausführlicheren Erläuterungen der Anleitung.



Was ist UDO?

Bevor UDO als Open Source freigegeben wurde, war es ein Sharewareprogramm von Dirk Hagedorn, das vornehmlich dazu dient, Anleitungen und ähnliche Texte, die in mehreren Formaten vorliegen müssen, zu erstellen.

Um das verdeutlichen, zitiere ich kurz die Enstehungsgeschichte von UDO, die der Autor in der Anleitung zum Programm präsentiert:

"Irgendwann im Herbst 1994 hatte ich mehrere kleinere Programme geschrieben, für die ich je eine ASCII-Anleitung, eine Online-Hilfe und ein gedrucktes Handbuch benötigte. Ich begann jeweils damit, zunächst die ASCII-Anleitung zu schreiben, in eine Kopie der ASCII-Anleitung die Hypertextkommandos einzufügen und schließlich die ASCII-Anleitung in eine Textverarbeitung zu importieren, um sie neu zu formatieren und auszudrucken.

Schnell stellte sich heraus, daß dieser Weg ziemlich mühsam war, denn bei auch nur kleinen Änderungen mußten diese in gleich drei Dateien durchgeführt werden. Bei größeren Änderungen mußte der ganze manuelle Umwandlungsvorgang erneut durchgeführt werden."

Um diese wenig effiziente Arbeitsweise in Zukunft zu vermeiden, entwickelte er also ein neues Textformat und ein dazu passendes Programm, das Texte, die in diesem Format vorlagen, in verschiedene Zielformate konvertieren konnte. Das Ganze bekam dann den Namen UDO (Universal Dokument).

Beim UDO handelt es sich - genau wie bei bspw. LaTex oder HTML - um ein "tagged ASCII"-Format: In einen ganz normalen ASCII-Text, wie er mit jedem Texteditor erzeugt wird, werden bestimmte Befehle und Steuerkommandos eingefügt. Wer es bei diesen Worten mit der Angst zu tun bekommt, weil er vom WYSIWYG moderner Applikationen verwöhnt ist, den kann ich beruhigen: Die UDO-Syntax ist, wie ich mittlerweile selbst erfahren konnte, wirklich sehr einfach zu erlernen. Die ersten Dokumente hat man nach wenigen Stunden geschrieben; und irgendwann kommt dann meistens von alleine der Wunsch auf, daß die Ergebnisse doch noch ein wenig "professioneller" aussehen könnten, und man vertieft seine UDO-Erkenntnisse.

Je nach Betriebssystem gibt es zwei Versionen des Programms UDO: Erstens eine Version mit grafischer Oberfläche (im folgenden GUI-Versionen genannt), in der man wie gewohnt komfortabel alle Parameter über Dialogboxen einstellen kann; sowie eine TTP-Version, die Kommandozeilen-Fetischisten erfreut und zudem den Quelltext schneller übersetzt.

[Fehlendes Bild: UDO-Screenshot]


{Der Hauptdialog von UDO in der Atari-GEM-Version}

Zunächst möchte ich einen allgemeinen Überblick über UDO geben, um anschließend einige der (meiner Meinung nach) herausragenden Funktionen aufzuführen. Danach befasse ich mich mit UDO und HTML - die "Sprache" des Internets gewinnt immer mehr an Bedeutung, und somit dürfte es interessant sein zu sehen, was UDO in dieser Hinsicht zu leisten vermag. Abschließend behandele ich dann noch kurz einige "sonstige" Punkte.

Übrigens wurde natürlich auch dieser Text mit UDO verfaßt und ins HTML-Format konvertiert; so kann ich auch schon mal demonstrieren, wie man mit Hilfe von UDO strukturierte Texte erzeugen kann. Deshalb ist der Artikel auch in mehrere Unterkapitel aufgeteilt. So könnt ihr direkt einige Navigationselemente, die UDO auf Wunsch automatisch erzeugt, bewundern:

  1. Am Ende eines Kapitels findet sich eine Übersicht (sozusagen ein "kleines Inhaltsverzeichnis") der ggf. folgenden untergeordneten Kapitel.
  2. Auf jeder Seite dieses Artikels finden sich jew. ganz oben und unten Navigationsbuttons, mit denen Ihr zwischen den einzelnen Seiten des Artikels hin- und hernavigieren könnt. Die Funktion dieser Buttons wird gleich erklärt.


Auch wenn es eigentlich nicht in die Einleitung eines Testberichts gehört, möchte ich an dieser Stelle schon einmal kurz eine der sinnvollsten UDO-Funktionen beschreiben: Die Navigationsbuttons.

[ Na, siehste nix? ] Dieser Button bringt bringt Euch sofort wieder zur ersten Seite des Artikels zurück.
 
[ Kein Wunder. ] Dieser Button verzweigt zur Anfangsseite der übergeordneten Gliederungsstufe. Also, wenn Ihr ihn z.B. in Kapitel 1.2.4 betätigt, landet Ihr am Anfang von Kapitel 1.2.
 
[ Du hast die Grafikdarstellung ja auch abgeschaltet. ] Hiermit gelangt Ihr auf die vorhergehende logische Seite. Nicht zu verwechseln mit dem "Zurück"-Button Eures Browsers. Betätigt Ihr ihn im Kapitel 1.2.4, landet Ihr in Kapitel 1.2.3.
 
[ Dann siehe unten. ] Und der hier bringt Euch auf die nächste logische Seite. Ein Klick auf diesen Button in Kapitel 1.2.4 bringt Euch nach Kapitel 1.2.5.
 

Zusätzlich gibt es die vier Buttons noch in einer deaktivierten Form:

[ Ohne Grafik siehste nix. ]

Diese könnt Ihr nicht anklicken - das heißt, Ihr könnt es schon, aber es bringt nichts. Die werden nämlich nur angezeigt, wenn es einen entsprechenden Verweis nicht gibt: Auf der letzten Seite kann es logischerweise keinen Link auf die nächste Seite geben.

Wenn Ihr die Grafikdarstellung Eures Browser abgeschaltet habt, oder Euer Browser gar keine Grafiken darstellen kann, erscheinen statt der Buttons die Namen der jeweiligen Kapitel.

Um den Navigationskomfort noch weiter zu erhöhen, gibt es die sog. toptocs. Sie stehen am Anfang jeder Seite und verweisen auf die übergeordneten Kapitel.


Diese Elemente erweisen sich gerade bei längeren, strukturierten Texten als wertvolle Hilfe bei der Navigation - und sie werden von UDO auf Wunsch vollautomatisch erzeugt.



Copyright © tobias@udo-open-source.de
Letzte Aktualisierung am 15. März 2001

Home Inhaltsverzeichnis Home UDO im Allgemeinen