############################################################
# @(#) basics.ui, Dirk Hagedorn, 24.10.1995
# 31.01.1996: "Umgebungen" erweitert
############################################################

!subnode Grundlagen

!subsubnode Let's talk about text, Baby!

!index Textdatei
!index Linefeed
!index Carriage Return

UDO erwartet als Quelldatei eine Textdatei, wie sie mit jedem
ASCII-Editor erstellt werden kann. Auer ASCII~9 (Tabulator), ASCII~10
(Linefeed) und ASCII~13 (Carriage Return) sollten keine
Steuerzeichen(!N)d.h. keine Zeichen mit einem ASCII-Wert kleiner als
32(!n) benutzt werden! Eine Zeile darf nicht lnger als 512 Zeichen sein.

UDO kmmert sich bei der Umwandlung selbstndig um die Formatierung des
Textes, sprich um den Zeilenumbruch und die Absatzabstnde:

!begin_description

!index Wort
!item [Wrter] sind Zeichenfolgen, die durch ein oder mehrere Leerzeichen
oder Tabulatoren voneinander getrennt sind. UDO gibt Wrter durch ein
Leerzeichen voneinander getrennt aus.

!index Absatz
!item [Abstze] sind Folgen von Wrter, die durch eine oder mehrere
Leerzeilen voneinander getrennt in der Quelldatei auftreten.  UDO sorgt
selbstndig fr den Zeilenumbruch innerhalb von Abstzen und gibt
automatisch die passende Anzahl von Leerzeilen zwischen zwei Abstzen aus.

!end_description

!index Zeichensatz

Quelltexte knnen in verschiedenen Zeichenstzen erstellt werden. UDO
versteht folgende Zeichenstze:

!begin_itemize !short
!item	Atari ST ((!idx [!/code_tos]))
!item	Apple Macintosh ((!idx [!/code_mac]))
!item	HP Roman 8 ((!idx [!/code_hp8]))
!item	IBM-PC ((!idx [!/code_dos]))
!item	ISO Latin 1, Windows ANSI ((!idx [!/code_iso]))
!end_itemize

Beim Start der Konvertierung erwartet UDO den aktuellen
Systemzeichensatz. Sollen Quelltexte konvertiert werden, die andere
Zeichenstze benutzen, mu man UDO dies mit den obigen Befehlen
kenntlich machen. Mehr zu diesem Thema findet man im Kapitel
""Sonderzeichen"".

#-----------------------------------------------------------

!subsubnode Kommandos, Schalter und Platzhalter

!begin_blist [Platzhalter:]
!index Kommando
!item [Kommandos:]
	Ein UDO-Kommando ist eine mit einem ""!"" beginnende Zeilenfolge, die
    am Anfang einer Zeile, eventuell eingerckt durch Leerzeichen oder
    Tabs, steht.  Ein Kommando bewirkt eine Aktion, wie z.B. die Ausgabe
    eines Inhaltsverzeichnisses (siehe (!I)!/tableofcontents(!i)).

!index Schalter
!item [Schalter:]
	Ein UDO-Schalter ist eine mit einem ""!"" beginnende Zeichenfolge,
    die die Aktionen von UDO oder einem Kommando beeinflussen. So gibt es
    z.B.  einen Schalter, der bewirkt, da Bezeichnungen in englischer
    Sprache(!N)""Appendix"" statt ""Anhang""(!n) ausgegeben werden (siehe
    (!I)!/language(!i)).

	Ein Schalter wird nur erkannt, wenn er am Anfang einer Zeile,
    eventuell eingerckt durch Leerzeichen oder Tabs eingerckt,
    steht.

!index Platzhalter
!item [Platzhalter:]
	Ein Platzhalter ist eine mit ""!"" beginnende Zeichenfolge, die durch
    runde Klammern eingefat ist. Ein Platzhalter wird von UDO durch eine
    dem Ausgabeformat zugehrige Zeichenfolge ersetzt (z.B. ''(!/B)'' durch
    ''(!V){\bf(!v)'').

	Platzhalter knnen an jeder beliebigen Stelle einer Zeile stehen.

!end_blist

#-----------------------------------------------------------
!subsubnode Kommentare

!index Kommantar

Es besteht die Mglichkeit, in einer Quelldatei Kommentare einzufgen.
Ist das erste Zeichen einer Zeile ein ""#"", so fat UDO diese Zeile als
Kommentar auf und wertet diese Zeile nicht aus.

Das ""#"" darf nicht eingerckt sein, mu also das erste Zeichen einer
Zeile sein!

Keine Regel ohne Ausnahme: Innerhalb einer verbatim- oder raw-Umgebug werden
alle Zeilen ausgegeben, also auch die Zeilen, die mit einem ""#"" beginnen.
Innerhalb dieser Umgebung knnen also keine Kommentare benutzt werden.

#-----------------------------------------------------------

!subsubnode Vorspann und Hauptteil

!index Vorspann
!index Hauptteil

Eine Quelldatei besteht immer aus einem Vorspann (auch ""Preambel"") und
einem Hauptteil.

!index !/begin_document

Im Vorspann werden grundstzliche Informationen ber den
umzuwandelnden Text selbst deklariert. Desweiteren knnen im
Vorspann spezielle Kommandos plaziert werden, die UDO mitteilen, wie er die
Quelldatei umwandeln soll(!N)z.B. ob ein kurzes oder ausfhrliches
Inhaltsverzeichnis ausgegeben werden soll, ob Begriffe und
Datumsangaben in deutscher oder englischer Sprache erfolgen sollen
etc.(!n). Zum Vorspann zhlen alle Zeilen, die vor dem Kommando
(!I)!/begin_document(!i) stehen.

!index !/end_document

Im Hauptteil schlielich befindet sich der nach Kapiteln,
Abschnitten und Unterabschnitten strukturierte Inhalt des
umzuwandelnden Textes. Der Hauptteil schliet mit dem Kommando
(!I)!/end_document(!i).


#-----------------------------------------------------------

!subsubnode Umgebungen

Eine Umgebung ist ein Teil der Quelldatei, der speziell behandelt
werden soll. Umgebungen werden jeweils mit (!I)!/begin_(!i) eingeleitet und
mit (!I)!/end_(!i) beendet. Diese Befehle mssen dabei jeweils am Anfang
einer Zeile stehen, eventuell eingerckt durch Leerzeichen und/oder
Tabulatoren.

Es gibt zahlreiche Umgebungen, die Ihnen die Arbeit erleichtern knnen und
die die jeweiligen ausgabeformatspezifischen
Besonderheiten bercksichtigen.  Hier eine bersicht:

!begin_xlist [description-Umgebung:] !short

!item	[appendix-Umgebung:]	Anhang
!item	[center-Umgebung:]		Zentrierungen
!item	[description-Umgebung:]	Beschreibungen
!item	[document-Umgebung:]	Dokument-Inhalt
!item	[enumerate-Umgebung:]	numerierte Aufzhlungen
!item	[flushleft-Umgebung:]	linksbndiger Text
!item	[flushright-Umgebung:]	rechtsbndiger Text
!item	[itemize-Umgebung:]		einfache Aufzhlungen
!item	[quote-Umgebung:]		Einrckungen
!item	[raw-Umgebung:]			spezielle Befehle des Ausgabeformats
!item	[table-Umgebung:]		Tabellen
!item	[verbatim-Umgebung:]	vorformatierter Text
!item	[xlist-Umgebung:]		Listen

!end_xlist

Wie der Text, der innerhalb dieser Umgebungen steht, behandelt wird, lesen
Sie bitte in den zugehrigen Kapiteln nach.