Die Kommandoreferenz zu UDO Release 3-0.17 17. April 1995 von Dirk Hagedorn In der Esmecke 9 D-59846 Sundern MausNet: Dirk Hagedorn @ MK2 Inhaltsverzeichnis ================== 1 Kommandoreferenz 1 Kommandoreferenz ================== *!A* Ein Platzhalter und wird durch den Inhalt von '!author' ersetzt. *!asc* Eine Zeile, die so beginnt, wird nur bei der Wandlung nach ASCII ausgegeben. Innerhalb dieser Zeile werden weitere UDO-Kommandos nicht bercksichtigt! *!=asc* Eine Zeile, die so beginnt, wird nur bei der Wandlung nach ASCII *nicht* ausgegeben. Innerhalb dieser Zeile werden weitere UDO-Kom- mandos nicht bercksichtigt! *!asc_no_effects* Taucht dieses Kommando im Text auf, so werden keine "DFš-Effekte" bei der ASCII-Ausgabe benutzt. *!asc_short_toc* Falls dieses Kommando vor '!tableofcontents' auftaucht, wird ein kurzes Inhaltsverzeichnis ausgegeben, wenn nach ASCII gewandelt wird. *!asc_subtoc* Listet alle zu einem Kapitel geh”renden Abschnitte auf, falls nach ASCII gewandelt wird. *!asc_subsubtoc* Listet alle zu einem Abschnitt geh”renden Unterabschnitte auf, falls nach ASCII gewandelt wird. *!arcname* Alles, was diesem Kommando folgt, wird fr den Platzhalter '!C' ersetzt. *!author* Alles, was nach diesem Kommando folgt, wird auf der Titelseite als Name des Autors bzw. fr die Ersetzung des Platzhalters '!A' benutzt. *!begin_appendix* Leitet den Anhang ein. Nachfolgende Kapitel werden mit Grožbuch- staben gekennzeichnet. Bei der Wandlung nach TeX wird einfach \begin{appendix} ausgegeben. *!begin_description* Leitet eine Description-Umgebung ein. Die Description-Umgebung ist bis zu viermal schachtelbar. *!begin_document* Hat nur fr TeX und RTF eine Bedeutung und wird dort durch \begin{document} bzw. durch den typischen RTF-Header mit den Ab- satzformaten und der Fonttabelle ersetzt. Ansonsten wird es ein- fach gefiltert. *!begin_enumerate* Leitet eine Enumerate-Umgebung, also einen Textbereich, in dem eine numerierte Aufz„hlung per !item' vorgenommen wird. Diese Um- gebung ist bis zu viermal schachtelbar. *!begin_itemize* Leitet eine Itemize-Umgebung, also einen Textbereich, in dem eine einfache Aufz„hlung per '!item' vorgenommen wird. Diese Umgebung ist bis zu viermal schachtelbar. *!begin_quote* Leitet eine neue Quote-Umgebung ein, d.h. der bis '!end_quote' folgende Text wird eingerckt. Die Quote-Umgebung ist bis zu viermal schachtelbar. *!begin_verbatim* Leitet eine Verbatim-Umgebung ein, was soviel bedeutet, daž alle Zeilen bis '!end_verbatim' ohne Umwandlung ausgegeben werden, wobei allerdings etwaige Einrckungen aufgrund einer Itemize-, Enumerate- oder Quote-Umgebung bercksichtigt werden. *!C* Ein Platzhalter. Wird durch den Inhalt von '!arcname' ersetzt. *!D* Ein Platzhalter. Wird durch den Inhalt von '!date' ersetzt. *!date* Alles, was nach diesem Kommando folgt, wird auf der Titelseite als Erstellungsdatum des Programms bzw. der Dokumentation benutzt bzw. fr die Ersetzung des Platzhalters '!D' benutzt. *!E* Ein Platzhalter. Wird durch den Inhalt von '!email' ersetzt. *!email* Alles, was nach diesem Kommando folgt, wird auf der Titelseite als EMail-Adresse des Autors bzw. fr die Ersetzung des Platzhal- ters '!E' benutzt. *!end_appendix* Beendet den Anhang. Nachfolgende Kapitel werden wieder mit Zahlen numeriert. Bei der Wandlung nach TeX wird '\end{appendix}' ausge- geben. *!end_description* Beendet eine Description-Umgebung. *!end_document* Hat nur fr TeX und RTF eine Bedeutung und wird dort durch '\end{document}' bzw. durch '}' ersetzt. Ansonsten wird es ein- fach gefiltert. *!end_enumerate* Beendet eine Enumerate-Umgebung. *!end_itemize* Beendet eine Itemize-Umgebung. *!end_quote* Beendet eine Quote-Umgebung. *!end_verbatim* Beendet eine Verbatim-Umgebung. *(!grin)* Wird zu bei der Wandlung nach TeX in '\verb|;-)|' gewandelt, ansonsten in ';-)'. *!html* Eine Zeile, die so beginnt, wird nur bei der Wandlung nach HTML ausgegeben. Innerhalb dieser Zeile werden weitere UDO-Kommandos nicht bercksichtigt! *!=html* Eine Zeile, die so beginnt, wird nur bei der Wandlung nach HTML *nicht* ausgegeben. Innerhalb dieser Zeile werden weitere UDO-Kom- mandos nicht bercksichtigt! *!hyphen T* 'T' ist ein Trennvorschlag, den UDO in eine interne Liste ber- nimmt. Siehe auch Kapitel "Silbentrennung". *!image F B* "Fgt" ein GEM-Image 'F' mit der (optionalen) Bildunterschrift 'B' bei der Wandlung nach ST-Guide oder TeX in die Zieldatei "ein". Bei allen anderen Formaten wird dieser Befehl gefiltert. *!include F* Die Datei F wird in den Quelltext aufgenommen. In der Datei F drfen alle UDO-Kommandos vorkommen. Etwaige Kapitel etc. werden mit ins Inhaltsverzeichnis bernommen. *!item* Leitet einen Aufz„hlungspunkt innerhalb einer Enumerate-, Itemize- oder Description-Umgebung ein. Innerhalb einer Description-Umge- bung k”nnen Worte, die direkt (durch ein Leerzeichen getrennt) auf '!item' folgen, durch eckige Klammern eingeschlossen werden. Diese Worte werden dann nach der Wandlung fett dargestellt. Die Anzahl der Aufz„hlungspunkte ist nicht eingeschr„nkt. *(!laugh)* Wird zu bei der Wandlung nach TeX in '\verb|:-)|' gewandelt, ansonsten in ':-)'. *!label* Wird zu bei der Wandlung nach TeX in '\label{...}', nach ST-Guide in '@symbol "..."'. Bei der Wandlung nach PC-Help wird das, was '!label' folgt, als 'sensitive(...)' mit in die Seitenber- schrift bernommen. Bei allen anderen Wandlungen ist '!label' nicht relevant. *!link* ... Hier fehlt noch etwas *!maketitle* Erzeugt aus den bei '!title', '!author' etc. gemachten Angaben eine Titelseite. Bei der Wandlung nach ST-Guide erfolgt die Ausga- be dieser "Titelseite" nur dann, wenn man '!tableofcontents' be- nutzt. *!node* Leitet ein Kapitel ein. Ein Kapitelname darf maximal aus 128 Zeichen bestehen. *!newpage* Erzeugt bei Formaten, die einen Seitenumbruch verstehen, einen solchen. Versteht das Zielformat keinen Seitenumbruch, so wird dieses Kommando gefiltert. *!P* Ein Platzhalter. Wird durch den Inhalt von '!program' ersetzt. *!path F* Alles, was nach diesem Kommando folgt, wird fr die Ersetzung des Platzhalters '!L' benutzt. '!path' l„žt sich also prima fr den Platzhalter '!L' und das Kommando '!include' verwenden. *!pch* Eine Zeile, die so beginnt, wird nur bei der Wandlung nach PC- Help ausgegeben. Innerhalb dieser Zeile werden weitere UDO-Komman- dos nicht bercksichtigt! *!=pch* Eine Zeile, die so beginnt, wird nur bei der Wandlung nach PC- Help *nicht* ausgegeben. Innerhalb dieser Zeile werden weitere UDO- Kommandos nicht bercksichtigt! *!pch_short_toc* Falls dieses Kommando vor '!tableofcontents' auftaucht, wird ein kurzes Inhaltsverzeichnis ausgegeben, wenn nach Pure-C-Help gewan- delt wird. *!pch_subtoc* Listet alle zu einem Kapitel geh”renden Abschnitte auf, falls nach Pure-C-Help gewandelt wird. *!pch_subsubtoc* Listet alle zu einem Abschnitt geh”renden Unterabschnitte auf, falls nach Pure-C-Help gewandelt wird. *!program* Alles, was nach diesem Kommando folgt, wird auf der Titelseite als Programmname bzw. fr die Ersetzung des Platzhalters '!P' be- nutzt. *!R* Ein Platzhalter. Wird durch den Inhalt von '!version' ersetzt. *!rtf* Eine Zeile, die so beginnt, wird nur bei der Wandlung nach RTF ausgegeben. Innerhalb dieser Zeile werden weitere UDO-Kommandos nicht bercksichtigt! *!=rtf* Eine Zeile, die so beginnt, wird nur bei der Wandlung nach RTF *nicht* ausgegeben. Innerhalb dieser Zeile werden weitere UDO-Kom- mandos nicht bercksichtigt! *!rtf_monofont* Das, was hinter 'rtf_monofont' folgt, wird bei der Wandlung nach RTF als Font fr die Verbatim-Umgebung benutzt. Fehlt diese Anga- be, wird der Speedo-Font 'Monospace 821' benutzt. *!rtf_no_quotes* Taucht dieses Kommando in einem Quelltext auf, so werden bei der RTF-Ausgabe die doppelten Anfhrungszeichen nicht in die 'korrek- ten deutschen' Anfhrungszeichen gewandelt, sondern in ein norma- les Anfhrungszeichen. *!rtf_propfont* Das, was hinter 'rtf_propfont' folgt, wird bei der Wandlung nach RTF als Standardfont. Fehlt diese Angabe, wird der Speedo-Font 'Dutch 801 Roman' benutzt. *!S* Ein Platzhalter. Wird durch den Inhalt von '!street' ersetzt. *!short_toc* Taucht dieses Kommando irgendwo im File auf, so wird ein kurzes Inhaltsverzeichnis erzeugt ("short table of contents"). In dieser kurzen Version werden keine Subnodes und Subsubnodes aufgefhrt. *!street* Alles, was nach diesem Kommando folgt, wird auf der Titelseite in der Adresse des Autors bzw. fr die Ersetzung des Platzhalters '!S' benutzt. *!stg* Eine Zeile, die so beginnt, wird nur bei der Wandlung nach ST- Guide ausgegeben. Innerhalb dieser Zeile werden weitere UDO-Kom- mandos nicht bercksichtigt! *!=stg* Eine Zeile, die so beginnt, wird nur bei der Wandlung nach ST- Guide *nicht* ausgegeben. Innerhalb dieser Zeile werden weitere UDO- Kommandos nicht bercksichtigt! *!stg_no_headlines* Taucht dieses Kommando irgendwo am Anfang einer Zeile auf, so werden bei der Konvertierung nach ST-Guide in den Nodes keine Ti- telzeilen ausgegeben. *!stg_short_title* Falls dieses Kommando vor '!maketitle' auftaucht, so werden in den Kopf der Titelseite keine Leerzeilen eingefgt. Dadurch wird die Titelseite etwas krzer, allerdings meines Erachtens auch h„žlicher. *!stg_short_toc* Falls dieses Kommando vor '!tableofcontents' auftaucht, wird ein kurzes Inhaltsverzeichnis ausgegeben, wenn nach ST-Guide gewan- delt wird. *!stg_subtoc* Listet alle zu einem Kapitel geh”renden Abschnitte auf, falls nach ST-Guide gewandelt wird. *!stg_subsubtoc* Listet alle zu einem Abschnitt geh”renden Unterabschnitte auf, falls nach ST-Guide gewandelt wird. *!subnode* Leitet ein Abschnitt ein. *!subsubnode* Leitet einen Unterabschnitt ein. *!subtoc* Listet alle zu einem Kapitel geh”renden Abschnitte auf. *!subsubtoc* Listet alle zu einem Abschnitt geh”renden Unterabschnitte auf. *!T* Ein Platzhalter. Wird durch den Inhalt von '!town' ersetzt. *!tableofcontents* Dieser Befehl gibt ein Inhaltsverzeichnis des Dokumentes aus. Wurde das Kommando '!short_toc' benutzt, so werden nur die Namen der Kapitel ausgegeben. Bei der Wandlung nach ST-Guide wird hier zus„tzlich die Titelsei- te erzeugt, falls zuvor '!maketitle' angegeben wurde. *!tex* Eine Zeile, die so beginnt, wird nur bei der Wandlung nach TeX ausgegeben. Innerhalb dieser Zeile werden weitere UDO-Kommandos nicht bercksichtigt! *!=tex* Eine Zeile, die so beginnt, wird nur bei der Wandlung nach TeX *nicht* ausgegeben. Innerhalb dieser Zeile werden weitere UDO-Kom- mandos nicht bercksichtigt! *!tex_lindner* Mit diesem Kommando gibt man an, daž man mit dem Lindner-TeX arbeitet. Dieses Kommando ist wichtig fr das Kommando '!image'. *!tex_strunk* Mit diesem Kommando gibt man an, daž man mit dem Strunk-TeX arbei- tet. Dieses Kommando ist wichtig fr das Kommando '!image'. *!title* Alles, was nach diesem Kommando folgt, wird auf der Titelseite als Einleitung benutzt. *!town* Alles, was nach diesem Kommando folgt, wird auf der Titelseite in der Adresse des Autors bzw. fr die Ersetzung des Platzhalters '!T' benutzt. *!version* Alles, was nach diesem Kommando folgt, wird auf der Titelseite als Versionsnummer bzw. fr die Ersetzung des Platzhalters '!R' benutzt. *!1wp* Eine Zeile, die so beginnt, wird nur bei der Wandlung nach 1st- Word ausgegeben. Innerhalb dieser Zeile werden weitere UDO-Komman- dos nicht bercksichtigt! *!=1wp* Eine Zeile, die so beginnt, wird nur bei der Wandlung nach 1st- Word *nicht* ausgegeben. Innerhalb dieser Zeile werden weitere UDO- Kommandos nicht bercksichtigt! *!1wp_short_toc* Falls dieses Kommando vor '!tableofcontents' auftaucht, wird ein kurzes Inhaltsverzeichnis ausgegeben, wenn nach 1stWord gewandelt wird. *!1wp_subtoc* Listet alle zu einem Kapitel geh”renden Abschnitte auf, falls nach 1stWord gewandelt wird. *!1wp_subsubtoc* Listet alle zu einem Abschnitt geh”renden Unterabschnitte auf, falls nach 1stWord gewandelt wird. *(!nl)* 'newline' erzwingt einen Zeilenumbruch. *(!B)...(!b)* ... wird fett ausgegeben. *(!F)...(!f)* ... wird fr TeX mit \fbox{} geklammert, bei allen anderen Forma- ten gefiltert. *(!N)...(!n)* ... ist eine Fužnote und wird bei den Formaten, die Fužnoten un- tersttzen, als solche gewandelt. Ansonsten wird die Fužnote in Klammern gesetzt. *(!U)...(!u)* ... wird unterstrichen ausgegeben. *(!V)...(!v)* Alles, was zwischen diesen beiden Kommandos steht, wird bei TeX durch '\verb' geklammert, bei RTF durch einen nichtproportionalen Font ausgegeben und bei allen anderen einfach gefiltert.