/usr/share/doc/udo-doc-de/html/005001.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
        "http://www.w3.org/TR/html4/loose.dtd">
<!-- last modified on 18.09.2017 -->
<html lang="de">
<head>
<title>
Die Anleitung zu UDO: Quelltext-Beispiel
</title>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<meta http-equiv="Content-Language" content="de">
<meta http-equiv="Content-Style-Type" content="text/css">
<meta http-equiv="Content-Script-Type" content="text/javascript">
<meta name="Generator" content="UDO 6.4 PL1 for Linux">
<meta name="Author" content="Dirk Hagedorn">
<link rel="chapter" href="intro.html" title="Einf&uuml;hrung">
<link rel="chapter" href="opensrc.html" title="Open Source">
<link rel="chapter" href="install.html" title="Installation">
<link rel="chapter" href="usage.html" title="Bedienung">
<link rel="chapter" href="syntax.html" title="Die UDO-Syntax">
<link rel="chapter" href="tips.html" title="Tips &amp; Tricks">
<link rel="section" href="005002.html" title="Grundlagen">
<link rel="section" href="005003.html" title="Gliederung">
<link rel="section" href="005004.html" title="Texthervorhebungen">
<link rel="section" href="005005.html" title="Sonderzeichen">
<link rel="section" href="005006.html" title="Silbentrennung">
<link rel="section" href="005007.html" title="Bilder">
<link rel="section" href="005008.html" title="Hypertext-Elemente">
<link rel="section" href="005009.html" title="Miszellaneen">
<link rel="appendix" href="faq.html" title="Wieso, weshalb, warum">
<link rel="appendix" href="bugs.html" title="Bugs">
<link rel="appendix" href="errormsg.html" title="Fehlermeldungen">
<link rel="appendix" href="thisthat.html" title="Dies &amp; das">
<link rel="appendix" href="history.html" title="Historie">
<link rel="appendix" href="cmdindex.html" title="Befehlsindex">
<link rel="start" href="index.html" title="Beginn des Dokumentes">
<link rel="home" href="index.html" title="Beginn des Dokumentes">
<link rel="contents" href="index.html#UDOTOC" title="Inhaltsverzeichnis">
<link rel="toc" href="index.html#UDOTOC" title="Inhaltsverzeichnis">
<link rel="first" href="intro.html" title="Einf&uuml;hrung">
<link rel="prev" href="syntax.html" title="Die UDO-Syntax">
<link rel="previous" href="syntax.html" title="Die UDO-Syntax">
<link rel="next" href="005002.html" title="Grundlagen">
<link rel="last" href="_f01600d.html" title="---">
<link rel="copyright" href="aboutudo.html" title="UDO6">
</head>
<body bgcolor="#FFFFFF">

<a href="index.html"><img src="udo_hm.gif" alt="Home" border="0" width="24" height="24"></a>
<a href="syntax.html"><img src="udo_up.gif" alt="Die UDO-Syntax" border="0" width="24" height="24"></a>
<a href="syntax.html"><img src="udo_lf.gif" alt="Die UDO-Syntax" border="0" width="24" height="24"></a>
<a href="005002.html"><img src="udo_rg.gif" alt="Grundlagen" border="0" width="24" height="24"></a>
<hr>
<h1><a name="Quelltext-Beispiel">Quelltext-Beispiel</a></h1>
<p>Bevor ich ins Detail gehen werde, m&ouml;chte ich Ihnen an dieser
Stelle ein Beispiel eines kompletten Quelltextes zeigen, welches Ihnen
auch dazu dienen kann, eigene Quelltexte mit UDO zu erstellen:
</p>
<blockquote>
<hr>
<pre>########################################
# @(#) UDO-Beispiel-Quelltext
# @(#) <a href="001005.html#Dirk_20Hagedorn">Dirk Hagedorn</a>, 08.04.1996
########################################

<a href="_f00f001.html">!raw</a> [stg] @subject &quot;Dokumentation/Utilities&quot;

<a href="_f00500c.html">!docinfo [title]</a>   Ein
<a href="_f005009.html">!docinfo [program]</a> UDO-Beispiel-Quelltext
<a href="_f005007.html">!docinfo [date]</a>    <a href="_f011010.html">(!today)</a>
<a href="_f005004.html">!docinfo [author]</a>  <a href="001005.html#Dirk_20Hagedorn">Dirk Hagedorn</a>

<a href="_f012008.html">!use_auto_subtocs</a>    [info,html,stg,tvh,win,aqv]
<a href="_f012007.html">!use_auto_subsubtocs</a> [info,html,stg,tvh,win,aqv]
<a href="_f00d003.html">!no_effects</a>          [asc]
<a href="_f01200b.html">!use_justification</a>   [asc]

########################################

<a href="_f003006.html">!begin_document</a>
<a href="_f00c002.html">!maketitle</a>
<a href="_f011004.html">!tableofcontents</a>

<a href="_f00d00d.html">!node</a> Automatische Formatierung

UDO sorgt selber f&uuml;r die Formatierung
des Quelltextes. Es n&uuml;tzt nichts, zwischen
zwei                          Worte
mehrere Leerzeichen einzuf&uuml;gen, da UDO selber f&uuml;r die
richtigen Wortabst&auml;nde und den Zeilenumbruch sorgt.


Auch n&uuml;tzt es nichts, zwischen zwei Abs&auml;tze mehrere
Leerzeilen einzuf&uuml;gen. Auch hier greift UDO ein und trennt
Abs&auml;tze durch die ihm richtig erscheinende Anzahl von
Leerzeilen.

Abs&auml;tze trennt man durch Leerzeilen oder UDO-Befehle.


<a href="_f00d00d.html">!node</a> Ein Kapitel
Dies ist der Text des Kapitels.

Bei Hypertexten erfolgt aufgrund der im Vorspann gesetzten
Schalter hier eine Auflistung aller diesem Kapitel
zugeh&ouml;rigen Abschnitte und Unterabschnitte.

<a href="_f010008.html">!subnode</a> Ein Abschnitt.
Dies ist der Text des Abschnitts. Auch hier folgt ein
Unterinhaltsverzeichnis.

<a href="_f01000b.html">!subsubnode</a> Ein Unterabschnitt.
Dies ist der Text des Unterabschnitts.

<a href="_f006007.html">!end_document</a>

</pre>
<hr>
</blockquote>
<h3>Erl&auml;uterungen</h3>
<p>Zu Beginn des Quelltextes ist ein Kommentar angegeben, damit man
sp&auml;ter noch auf Anhieb erkennen kann, womit sich der Text
befa&szlig;t. Eine Zeile bewertet UDO als Kommantar, wenn das erste
Zeichen der Zeile ein `#' ist.
</p>
<p>Es folgt eine spezielle Zeile f&uuml;r 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.
</p>
<p>Nun werden die Informationen f&uuml;r die <a href="005003001.html">Titelseite</a> 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
w&uuml;rde bei einigen Formaten in den Kopfzeilen &quot;Ein
UDO-Bespiel-Quelltext&quot; ausgegeben. Bei <i>!date</i> wird der
Platzhalter <i><a href="_f011010.html">(!today)</a></i> durch das aktuelle Systemdatum
expandiert. Sie k&ouml;nnen nat&uuml;rlich auch manuell f&uuml;r die
Angabe des Datums sorgen (z.B. <tt>!date 31. Dezember 1999</tt>.
</p>
<p>Im Vorspann werden nun noch einige Schalter gesetzt. Die ersten
beiden Schalter sorgen bei Hypertexten, deren K&uuml;rzel Sie in den
eckigen Klammern erkennen, f&uuml;r 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 erm&ouml;glicht, direkt zu den
zugeh&ouml;rigen Abschnitten weiterzuklicken. Theoretische w&auml;re
es auch m&ouml;glich, bei jedem Kapitel durch die Angabe des Befehls
<i><a href="_f010011.html">!subtoc</a></i> bzw. bei jedem Abschnitt durch die Angabe des Befehls
<i><a href="_f010010.html">!subsubtoc</a></i> diese Unterinhaltsverzeichnisse einzuf&uuml;gen.
Bei kleineren Texten empfiehlt es sich jedoch, diese Ausgabe zu
automatisieren.
</p>
<p>Der Schalter <i><a href="_f00d003.html">!no_effects</a> [asc]</i> sorgt f&uuml;r die
Unterdr&uuml;ckung der <a href="00500400b.html">Schriftarten</a> f&uuml;r das ASCII-Format.
W&uuml;rde dieser Schalter nicht angegeben, so w&uuml;rde UDO beim
ASCII-Format die in der DF&Uuml; gebr&auml;uchlichen Zeichen zur
Schriftartumschaltung benutzen.
</p>
<p>Der Schalter <i>!use_justified [asc,stg]</i> sorgt daf&uuml;r,
da&szlig; UDO beim ASCII- und ST-Guide-Format Blocksatz erzeugt.
</p>
<p>Das Kommando <i><a href="_f003006.html">!begin_document</a></i> teilt UDO mit, da&szlig; nun
der Hauptteil des Quelltextes beginnt. Dieses Kommando darf in keinem
Quelltext fehlen, da hier unverzichtbare Informationen f&uuml;r die
Ausgabeformate ausgegeben werden!
</p>
<p>Zu Anfang geben wir eine <a href="005003001.html">Titelseite</a> aus, die aus den Informationen
aus der im oberen Teil des Vorspanns gebildet wird. Das Kommando
<i><a href="_f00c002.html">!maketitle</a></i> sollte &ndash; wenn es benutzt wird &ndash; direkt
hinter <i><a href="_f003006.html">!begin_document</a></i> angegeben werden. UDO erlaubt zwar
auch den Einsatz an sp&auml;terer Stelle, jedoch ist dies weder
sinnvoll noch unproblematisch.
</p>
<p>Danach m&ouml;chten wir, da&szlig; 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><a href="_f011004.html">!tableofcontents</a></i> benutzt, so sollte er direkt hinter
<i><a href="_f00c002.html">!maketitle</a></i> oder (bei Verzicht auf die Ausgabe der <a href="005003001.html">Titelseite</a>)
hinter <i><a href="_f003006.html">!begin_document</a></i> angegeben werden.
</p>
<p>Endlich! Nach dem ganzen Vorgeplenkel beginnen wir mit dem Befehl
<i><a href="_f00d00d.html">!node</a></i> das erste Kapitel. Beachten Sie bitte auch den Inhalt
dieses Kapitels, da er weitere Informationen enth&auml;lt.
</p>
<p>Die folgenden Zeilen demonstrieren, wie man Kapitel, Abschnitte
und Unterabschnitte erzeugt. Auch hier sollten Sie einen Blick auf den
Text werfen.
</p>
<p>Unser Quelltext ist nun beendet. Dies zeigen wir UDO mit dem
Befehl <i><a href="_f006007.html">!end_document</a></i> an. Auch dieser Befehl darf in keinem
Quelltext fehlen!
</p>
<hr>
<a href="index.html"><img src="udo_hm.gif" alt="Home" border="0" width="24" height="24"></a>
<a href="syntax.html"><img src="udo_up.gif" alt="Die UDO-Syntax" border="0" width="24" height="24"></a>
<a href="syntax.html"><img src="udo_lf.gif" alt="Die UDO-Syntax" border="0" width="24" height="24"></a>
<a href="005002.html"><img src="udo_rg.gif" alt="Grundlagen" border="0" width="24" height="24"></a>
</body></html>
udo-doc-de 6.4.1-4 / usr / share / doc / udo-doc-de / html / 005001.html
