File: example.ui

package info (click to toggle)
udo 6.4.1-9
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,680 kB
  • sloc: ansic: 42,702; makefile: 81; cpp: 19
file content (97 lines) | stat: -rw-r--r-- 4,200 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
!subnode Quelltext-Beispiel

Bevor ich ins Detail gehen werde, mchte ich Ihnen an dieser Stelle ein
Beispiel eines kompletten Quelltextes zeigen, welches Ihnen auch dazu dienen
kann, eigene Quelltexte mit UDO zu erstellen:

!begin_quote
!hline
!vinclude syntax/example.u
!hline
!end_quote

!subsubheading Erluterungen

Zu Beginn des Quelltextes ist ein Kommentar angegeben, damit man spter noch
auf Anhieb erkennen kann, womit sich der Text befat. Eine Zeile bewertet
UDO als Kommantar, wenn das erste Zeichen der Zeile ein ''#'' ist.

Es folgt eine spezielle Zeile fr den ST-Guide. Hier wird dem
ST-Guide mitgeteilt, in welche Rubrik der Hypertext in den Katalog
einzuordnen ist. Kennen Sie sich nicht mit dem ST-Guide aus, so verwenden
Sie einfach diese Zeile zu Beginn Ihres Quelltextes.

!index !/title
!index !/program
!index (!/today)
!index !/date
Nun werden die Informationen fr die Titelseite und die Kopfzeilen gesetzt,
die bei einigen Formaten automatische erzeugt werden. (!I)!/title(!i) und
(!I)!/program(!i) bilden eine Einheit, daher sollte beides
zusammengenommen einen Sinn ergeben. Hier wrde bei einigen
Formaten in den Kopfzeilen ""Ein UDO-Bespiel-Quelltext"" ausgegeben. Bei
(!I)!/date(!i) wird der Platzhalter (!I)(!/today)(!i) durch das aktuelle
Systemdatum expandiert. Sie knnen natrlich auch manuell fr die Angabe
des Datums sorgen (z.B. (!T)!/date 31. Dezember 1999(!t).

!index !/subtoc
!index !/subsubtoc
Im Vorspann werden nun noch einige Schalter gesetzt. Die ersten beiden
Schalter sorgen bei Hypertexten, deren Krzel Sie in den eckigen Klammern
erkennen, fr die Ausgabe sogenannter
''Unterinhaltsverzeichnisse''. In diesen werden dann alle
Abschnitte und Unterabschnitte eines Kapitels bzw.  alle
Unterabschnitte eines Abschnittes in Form eines
Inhaltsverzeichnisses aufgelistet. Dem Leser eines Hypertextes wird es
dadurch ermglicht, direkt zu den zugehrigen Abschnitten
weiterzuklicken. Theoretische wre es auch mglich, bei jedem Kapitel durch
die Angabe des Befehls (!I)!/subtoc(!i) bzw. bei jedem Abschnitt durch die
Angabe des Befehls (!I)!/subsubtoc(!i) diese Unterinhaltsverzeichnisse
einzufgen. Bei kleineren Texten empfiehlt es sich jedoch, diese Ausgabe zu
automatisieren.

!index !/no_effects
Der Schalter (!I)!/no_effects [asc](!i) sorgt fr die
Unterdrckung der Schriftarten fr das ASCII-Format. Wrde dieser
Schalter nicht angegeben, so wrde UDO beim ASCII-Format die in der DF
gebruchlichen Zeichen zur Schriftartumschaltung benutzen.

!index !/use_justified
Der Schalter (!I)!/use_justified [asc,stg](!i) sorgt dafr, da UDO
beim ASCII- und ST-Guide-Format Blocksatz erzeugt.

!index !/begin_document
Das Kommando (!I)!/begin_document(!i) teilt UDO mit, da nun der Hauptteil
des Quelltextes beginnt. Dieses Kommando darf in keinem Quelltext
fehlen, da hier unverzichtbare Informationen fr die
Ausgabeformate ausgegeben werden!

!index !/maketitle
Zu Anfang geben wir eine Titelseite aus, die aus den Informationen aus
der im oberen Teil des Vorspanns gebildet wird. Das Kommando
(!I)!/maketitle(!i) sollte -- wenn es benutzt wird -- direkt hinter
(!I)!/begin_document(!i) angegeben werden. UDO erlaubt zwar auch den Einsatz
an spterer Stelle, jedoch ist dies weder sinnvoll noch unproblematisch.

!index !/tableofcontents
Danach mchten wir, da UDO ein Inhaltsverzeichnis ausgibt. In diesem sind
alle Kapitel, Abschnitte und Unterabschnitte des Quelltextes aufgelistet.
Das oben Gesagte gilt auch hier. Wird der Befehl (!I)!/tableofcontents(!i)
benutzt, so sollte er direkt hinter (!I)!/maketitle(!i) oder (bei Verzicht
auf die Ausgabe der Titelseite) hinter (!I)!/begin_document(!i) angegeben
werden.

!index !/node
Endlich! Nach dem ganzen Vorgeplenkel beginnen wir mit dem Befehl
(!I)!/node(!i) das erste Kapitel. Beachten Sie bitte auch den Inhalt dieses
Kapitels, da er weitere Informationen enthlt.

Die folgenden Zeilen demonstrieren, wie man Kapitel, Abschnitte und
Unterabschnitte erzeugt. Auch hier sollten Sie einen Blick auf den Text
werfen.

!index !/end_document
Unser Quelltext ist nun beendet. Dies zeigen wir UDO mit dem Befehl
(!I)!/end_document(!i) an. Auch dieser Befehl darf in keinem Quelltext
fehlen!