Public Domain: UDO Release 5

UDO steht als Abkürzung für „Universal Document“ und ist zugleich die Bezeichnung eines neuen Textformates und des zugehörigen Programms, das eben dieses UDO-Format wahlweise in eines der folgenden Formate umwandeln kann: ASCII, ST-Guide, Pure-C-Help, LaTeX 2.09 oder LaTeX2e, Rieh Text Format (RTF), Flypertext Markup Language (HTML), Manualpage, GNU-Texinfo, Windows-Help, Turbo-Vision-Help und Linuxdoc-SGML.

Da die Bedienung der Programme (GEM- und Kommandozeilenversion) ziemlich trivial ist, möchten wir uns hier näher mit dem U DO-Format befassen. UDO erwartet Textdateien, die mit speziellen Kommandos angereichert sind, die stark an die Befehle von LaTeX und des HCP (des Hypertextcompilers des ST-Guide) erinnern. Diese Quelltexte lassen sich also mit jedem gebräuchlichen Editor(z.B. Everest, 7up, JAnE, qed) erstellen.

Beispiel-Listing als RTF in Papyrus eingeladen

Nun wird sich vielleicht der eine oder andere fragen, wozu dieses Programm denn gut sein soll. Der Autor beantwortet diese Frage daher gleich zu Beginn der (übrigens sehr ausführlichen) Anleitung mit folgendem Satz: „UDO wurde entwickelt, um die Erstellung von Anleitungen zu Computerprogrammen oder vergleichbaren Dokumentationen zu vereinfachen, die in mehr als einem Format benötigt werden." Der Autor eines Programms braucht demnach nur noch einen UDO-Quelltext zu bearbeiten und kann diesen dann in -Anleitung (z.B. LIESMICH.TXT) und einen ST-Guide-Hypertext umwandeln sowie ein gedrucktes Handbuch mit LaTeX setzen oder mit einer Textverarbeitung, die das Rich-Text-Format importieren kann, ausdrucken. Neben der reinen Umwandlung der Quelltexte in das gewünschte Format wird dem Autor einer Dokumentation eine Menge Arbeit abgenommen, da UDO sich komplett um das Layout des Textes, um die Kapitelnumerierung oder die Erzeugung eines Inhaltsverzeichnisses kümmert. UDO unterstützt verschiedenartige Listen (wie z.B. numerierte Listen wie am Anfang dieses Artikels, Quelltext s.u.), zentrierten Text, eingerückten Text oder einfache Tabellen. Dabei werden die Möglichkeiten des gewünschten Formates ausgeschöpft, und bei den Formaten, die keine Layout-Möglichkeiten bieten (wie ASCII), springt UDO für das Textlayout ein. So werden z.B. Tabellen in LaTeX-oder HTML-Tabellen umgewandelt, während sich UDO beim ASCII-Format um die Ausgabe der Tabellenlinien und die Ausrichtung der Zellen derTabelle kümmert. Beispiel:

Beispiel-Listing als HTML in CAB eingeladen

!begin_enumerate
!item ASCII
!item ST-Guide
!item Pure-C-Help
!item (ILaTeX) 2.09 oder (!LaTeX)2e
!item Rieh Text Format (RIF)
!item Hypertext Markup Language (HTML)
!item Manualpage
!item GNU-Texinfo
!item Windows-Help
!item Turbo-Vision-Help
!item Linuxdoc-SGML
!end_enumerate

Da UDO auch für andere Betriebssysteme (Linux, HP-UX, MacOS, MS-DOS, Sl-NIX, Sun Spare ...) erhältlich ist, könnten Texte mit allgemeinem Inhalt auch als Quelltext weitergegeben werden, so daß Benutzer von UDO, die keinen TOS-Rechner besitzen, auch in den Genuß so mancher Information im gewünschten Format kommen können. UDO hält in der derzeit erhältlichen Version über 100 Befehle bereit, mit denen man einen Quelltext „programmieren“ kann. Allerdings braucht man für die Erstellung eines kleinen Textes lediglich ein paar Befehle zu kennen. Daher hier eine Minimalversion eines Quelltextes, der eine Titelseite, ein Inhaltsverzeichnis und ein Kapitel enthält und mit lediglich 8 Befehlen (UDO-Befehle beginnen mit einem Ausrufungszeichen) erstellt wird:

!author Joachim Heller  
!title Ein kleines Beispiel für  
!program UDO
Beispiel-Listing als Hypertext in ST-Guide eingeladen
!begin_document  
!maketitle  
!tableofcontents  
!node Hello, World!
Dies ist ein kleines Beispiel  
eines UDO-Queltextes. 
!enddocument

Trotz aller Möglichkeiten, die UDO bietet, dürfen die Nachteile nicht verschwiegen werden. So existieren derzeit keine Konverter, die bestehende Hypertexte im ST-Guide-Format ins UDO-Format umwandeln. Auch für andere Formate wie La-TeX, IstGuide oder Pure-C-Help werden keine Konverter angeboten. Handarbeit ist also angesagt, will man seine „alten“ Hypertexte oder Anleitungen mit UDO bearbeiten. Daher kann man UDO derzeit nur für zukünftige Anleitungen oder Hypertexte empfehlen. Ein weiteres Problem stellen die von UDO erzeugten RTF-Dateien dar. So werden keine echten RTF-Tabellen erzeugt; auch ist es nicht möglich. Bilder in eine RTF-Datei zu übernehmen. Zudem erscheint bei mancher Textverarbeitung nicht immer alles so, wie man es sich eigentlich wünschen würde. Ob letzteres allerdings ein Problem von UDO oder der jeweiligen Textverarbeitung ist, bleibt zu klären.

Fazit

Für den Fall, daß man einen Text in mehreren Formaten anbieten möchte, ist UDO derzeit eine ideale Lösung. Auch die Shareware-Gebühr von 40,- DM erscheint angesichts des großen Leistungsumfangs nicht zu hoch, auch wenn es hier und da noch kleinere Probleme gibt.

JH

Autor: Dirk Hagedorn
ST-PD: Nummer 908 + 909
Status: Shareware

Die GEM-Oberfläche von UDO


Aus: ST-Computer 07 / 1996, Seite 60

Links

Copyright-Bestimmungen: siehe Über diese Seite