Die Anleitung zu UDO: Allgemeine Fragen

Was bedeutet `FAQ'?

"FAQ" bedeutet "Frequently Asked Questions" und bedeutet übersetzt soviel wie "häufig gestellte Fragen". Im übertragenen Sinn versteht man darunter eine Auflistung eben dieser oft gestellten Fragen samt der passenden Antwort.

Wieso heißt UDO `UDO'?

Als ich mit der Programmierung von UDO begann, brauchte ich einen Namen. Mir fiel auf die Schnelle nichts besseres ein als die Abkürzung "UDO", was als Abkürzung für "Universal DOcument" steht.

Übrigens: Der Autor heißt mit Vornamen nicht Udo, sondern Dirk!

Wie spricht man `UDO' aus?

`UDO' wird genauso ausgesprochen wie der Vorname Udo, also `Uh-Doh'. `UDO' wird nicht anglophil wie `Judo' oder `You do' ausgesprochen!

Woher bekomme ich die aktuellen Versionen?

Die aktuellen Versionen sind im WWW unter http://www.udo-open-source.org/ erhältlich.

Wird es Portierungen auf andere Systeme geben?

Von UDO existieren momentan Versionen für folgende Systeme:

Atari TOS
DOS, OS/2, Windows
Linux x86
Mac OS

UDO wurde komplett in C geschrieben, verzichtet vollkommen auf betriebssystemspezifische Routinen. Dadurch könnte die Kommandozeilenversion von UDO theoretisch auf jedes beliebige System portiert werden, für das ein ANSI-C-Compiler existiert.

Wenn Sie an einer Portierung auf ein bestimmtes System interessiert sind und einen Compiler für dieses System besitzen, so kontaktieren Sie bitte die UDO-Entwickler.

Können auch `systemfremde' Formate erzeugt werden?

Mit UDO kann auf man jedem System natürlich auch Formate für andere Betriebssysteme erzeugt werden, da die Versionen identisch sind. So ist es möglich, mit der Atari-Version WinHelp-Quelltexte zu erzeugen oder unter OS/2 mit der DOS-Version ST-Guide-Quelltexte.

Lediglich eine Umsetzung der Sonderzeichen muss ggf. erfolgen. Dies kann man z.B. mit GNU-recode durchführen. Auf Wunsch gibt es auch bei mir ein Programm zur Umsetzung der Sonderzeichen in Textdateien.

Kann man Texte "hier" schreiben und "dort" konvertieren?

Ja, denn UDO versteht alle Zeichensätze der Systeme, für die UDO erhältlich ist. Somit können Texte unter DOS geschrieben werden und auf einem Unix-Rechner konvertiert werden.

Sogar in einer Datei können die Zeichensätze gewechselt werden, falls das nötig sein sollte. Durch einen Satz Befehle können Sie UDO mitteilen, welcher Zeichensatz in den folgenden Zeilen benutzt werden soll.

Kann sich die UDO-Syntax noch ändern?

UDO ist ein Programm, das ständig weiterentwickelt wird. Es werden sicherlich auch in Zukunft weitere Kommandos hinzukommen.

Teilweise wird es sich auch nicht vermeiden lassen, die Syntax einiger Kommandos zu ändern. Auf solche Änderungen wird aber besonders hingewiesen, so dass man die nötigen Anpassungen innerhalb von Minuten mit einem Editor vornehmen kann.

Wie funktioniert UDO?

UDO liest die Quelldatei(en) in zwei Durchgängen ein.

Im ersten Durchgang werden Schalter, Makros, Definitionen sowie die Namen der Kapitel für das Inhaltsverzeichnis und die automatische Referenzierung ermittelt.

Im zweiten Durchgang erfolgt dann die Konvertierung und Formatierung des Textes. UDO speichert bis zum Eintreffen einer Leerzeile bzw. eines Kommandos den Text in einem internen Puffer und gibt dann den eingelesenen Absatz aus bzw. führt das jeweilige Kommando aus.

Aus dem letzten Satz folgt: Leerzeilen und Kommandos unterteilen Absätze.

Wie referenziert UDO?

UDO legt bei den Hypertext-Formaten (außer beim ST-Guide-Format) im Text automatisch Querverweise zu Kapiteln und Sprungmarken an. Es werden dabei nur Verweise auf "andere" Seiten angelegt, also keine Verweise auf Stellen der aktuellen Seite.

Mit dem Schaltern !autoref kann man die automatische Referenzierung aus- (Parameter [off]) und wieder einschalten (Parameter [on]).

Wie verweist man auf Stellen des aktuellen Kapitels?

Da UDO nicht auf der Seite Verweise anlegt, auf der ein Label gesetzt wurde, gibt es ein Problem, falls man am Seitenende einen Verweis zum Seitenanfang anlegen will. Daher muss man hier einen manuellen Querverweis setzen.

!node  Test
!label Test Anfang
[...]
(!link [Zum Seitenanfang] [Test Anfang])

Wie bekomme ich Bilder in ein Inhaltsverzeichnis?

Dazu muss man auf den Befehl !tableofcontents verzichten und ein Kapitel anlegen, in welches das Inhaltsverzeichnis ausgegeben wird. In einem normalen Kapitel kann man natürlich Bilder wie sonst auch benutzen. Beispiel:

!begin_document
!maketitle
!node Inhaltsverzeichnis
!image foo
!toc [all]

!node Erstes Kapitel

Welchen Editor kann ich für UDO verwenden?

Hier einige Vorschläge:

"e" (e.exe)	OS/2	Bestandteil des Systems
Kate, KEdit, KWrite	Linux/KDE	Open Source
NotePad++	Windows	Freeware
Pepper	Linux, Mac, Windows	kommerziell
SciTe	Linux, Windows	Open Source
SuperEdi	Windows	Freeware
TextPad	Windows	Freeware
UltraEdit32	Windows	kommerziell