Home Einführung Vorwort Benötigen Sie UDO?
 Die Anleitung zu UDO
 Einführung

Was kann UDO und was nicht?

UDO wurde ursprünglich entwickelt, um die Erstellung von Anleitungen zu Computerprogrammen oder vergleichbaren Dokumentationen zu vereinfachen, die in mehreren Formaten benötigt werden.

UDO leistet aber auch gute Dienste, falls man nur ein Format erzeugen will. So ist es für Anfänger sicherlich einfacher, die Syntax von UDO zu begreifen als die von HTML oder LaTeX, denn bei letzterem muß man beispielsweise höllisch aufpassen, daß man nicht unerlaubte Zeichen im Quelltext einbaut, wogegen UDO auch mit Sonderzeichen klarkommt und diese automatisch an das jeweilige Ausgabeformat anpaßt. Sprich, selbst wenn man nur HTML oder nur LaTeX erzeugen will, kann UDO sehr gute Dienste leisten.

Bei alledem ist UDO multilingual, d.h. Sie können Texte in verschiedenen Sprachen erzeugen, und UDO wird dabei für die unterstützten Sprachen die jeweils passenden Begriffe für "Inhaltsverzeichnis", "Anhang", "Abbildung" oder "Tabelle" ausgeben oder das Datum im jeweiligen Format darstellen.

Die Syntax von UDO ist sehr leicht zu erlernen. Zur Erstellung einfacher Dateien muß man lediglich Kenntnis von etwa zehn bis fünfzehn Befehlen besitzen, also in etwa so viel, wie Sie auch beim Verfassen von HTML- oder LaTeX-Dateien besitzen müssen.

Haben Sie einen Quelltext erstellt, so können Sie diesen in folgende Formate umwandeln:

Kürzel Format-Name Erläuterung Plattform(en)
amg AmigaGuide Hypertext-System, vorwiegend zur Dokumentation von Amiga-Programmen Commodore Amiga
aqv Apple QuickView älteres Hypertext-Format unter MacOS Apple
asc ASCII "Plain" Text alle
drc David's Readme Compiler DOS-Programm zur Erzeugung menügesteuerter ReadMe's als EXE-Datei MS-DOS
helptag HP-Helptag-SGML SGML-basiertes Hypertext-Hilfesystem für kommerzielle Unices (HP-UX, Sun Solaris, IBM AIX) Unix
html HTML (Hypertext Markup Language) Seitenauszeichnungssprache, u.a. für Webseiten, Dokumentationen etc. plattformunabhängig
hh HTMLHelp zur Erzeugung von HTML-Help-Dateien unter Windows (HTML-Variante mit Erweiterungen) Win32
tex LaTeX 2.09, LaTeX2e Satzsystem, insbesondere für wissenschaftliche Publikationen zahlreiche Plattformen
ipf OS/2 IPF SGML-basiertes Textformat zur Erzeugung von Hilfedateien (INF, HLP) unter OS/2 OS/2
linuxdoc Linuxdoc-SGML Linuxdoc-SGML (neuerdings: SGMLtools) ist genau wie UDO ein Multiformat-Konverter, der sein eigenes Format in LaTeX, Manualpage, RTF, HTML, Texinfo etc. umwandeln kann Unix/Linux
lyx LyX LaTeX-verwandtes Dokumentenverarbeitungsprogramm Unix/Linux
man Manualpage Unix-/Linux-Hilfeseiten für Kommandozeilenprogramme/-aufrufe Unix/Linux
nroff NROFF Unix-/Linux-Hilfeseiten für Kommandozeilenprogramme/-aufrufe Unix/Linux
pdflatex PDFLaTeX zur Erzeugung von PDF-Dateien aus LaTeX diverse
ps PostScript geräteunabhängige Seitenbeschreibungssprache, z.B. zur Ansteuerung von Druckern; kann zur Erstellung von PDF-Dateien genutzt werden (Ghostscript, Adobe Distiller) diverse
pchelp Pure-C-Help Hilfesystem für den Pure C-Compiler Atari ST
rtf RTF (Rich Text Format) Textformat für den Textaustausch zwischen verschiedenen Textverarbeitungsprogrammen diverse
c, pascal Sourcecode (C und Pascal) Die UDO-Quelldatei wird in Sourcecode umgewandelt, d.h. normaler Text wird Kommentar, der Inhalt der Sourcecode-Umgebung wird C- bzw. Pascal-Source. diverse
stg ST-Guide Hypertextsystem Atari ST
info GNU Texinfo zur Erzeugung von Online-Dokumentationen mit dem Kommandozeilen-Aufruf info 'command' Linux, MiNTNet
v Turbo-Vision-Help zur Erstellung von Onlinehilfen für DOS-Programme, die mit Borlands Turbo Vision-Library geschrieben wurden MS-DOS
udo UDO führt alle UDO-Eingabedateien in eine einzige zusammen alle von UDO unterstützten
win, wh4 Windows-Help, WinHelp4 RTF-Variante zur Erzeugung von Win-Help-Dateien unter Windows Windows (Win16, Win32)

UDO erzeugt größtenteils keine `fertigen' Dokumente. In aller Regel müssen die von UDO erzeugten Dateien erst noch durch weitere Programme bearbeitet werden. So müssen Windows-Help-Quelltexte erst noch durch den Hypertext-Compiler HC.EXE bearbeitet werden, RTF-Dateien mit einer Textverarbeitung ausgegeben werden, etc.

UDO versucht, dem Verfasser des Textes soviel Arbeit wie möglich abzunehmen. Neben der reinen Umwandlung bietet UDO daher je nach Ausgabeformat sinnvolle Nützlichkeiten wie


UDO hat so seine Stärken und Schwächen. Die Umwandlung ins ASCII-Text-, ST-Guide-, HTML-, LaTeX- und WinHelp-Format gehören – historisch bedingt – sicherlich zu den Stärken dieses Programms. Ausgabeformate Linuxdoc-SGML und LyX werden erst seit kurzer Zeit angeboten und wurden noch nicht ausreichend getestet; hier gibt es sicherlich noch ein paar Dinge, die geändert werden (müssen).

Einige Dinge stehen ganz oben auf der Wunschliste, wie z.B. die automatische Erzeugung eines Stichwortverzeichnisses sowie die Ausgabe eines Abbildungs- und Tabellenverzeichnisses.


Die Erstellung von komplexen Dokumenten wie Zeitschriften ist mit UDO nicht möglich, da z.B. Bilder nicht frei positioniert oder von Text umflossen werden können und UDO keinen Spaltensatz erzeugen kann. Dies sind Funktionen, die zum Desktop Publishing gehören und in einem Programm wie UDO nichts zu suchen haben.

UDO besitzt keine eingebaute automatische Silbentrennung, sondern bietet nur die Möglichkeit, Wörter an vom Autor markierten Stellen zu trennen.

UDO ist nur ein Textkonverter "in eine Richtung", kann also nur das eigene Format in die oben aufgelisteten Formate umwandeln. UDO kann keines dieser Formate in das eigene Format umwandeln.


Copyright © www.udo-open-source.org
Letzte Aktualisierung am 2. Februar 2004

Home Einführung Vorwort Benötigen Sie UDO?