Die Anleitung 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 Einleitung 1.1 Vorwort 1.2 UDOs Geschichte 1.3 UDO's Zukunft 1.4 šber diese Anleitung 1.5 Bekannte M„ngel und Probleme 2 Shareware 3 Manualpage 4 Grundlagen 4.1 Textaufbau 4.1.1 Worte, Abs„tze & Kapitel 4.1.2 Vorspann & Hauptteil 4.1.3 Kommentare 4.2 Befehle 4.3 Bedingte Befehle 4.4 Umgebungen 4.5 Sonderzeichen 5 Gliederung 5.1 Titelseite 5.2 Inhaltsverzeichnis 5.3 Kapitel, Abschnitte und Unterabschnitte 5.4 Anhang 6 Formatierung 6.1 Žnderungen der Schrift 6.2 Textverschiebungen 6.2.1 Zentrierter Text 6.2.2 Eingerckter Text 6.3 Aufz„hlungen 6.3.1 Beispiel 'itemize' 6.3.2 Beispiel 'enumerate' 6.3.3 Beispiel 'description' 6.4 Ausgabe von Originaltext 6.5 Silbentrennung 6.6 Zeilenumbruch 6.7 Seitenumbruch 7 Grafikeinbindung 7.1 Grafikeinbindung fr den ST-Guide 7.2 Grafikeinbindung fr das Lindner-TeX 7.3 Grafikeinbindung fr das CS-TeX 8 Tips & Tricks 8.1 UDO und TeX 8.2 UDO und Pure-C-Help Anhang A Bezugsquellen B Danksagungen C Rechtliche Informationen C.1 Copyright C.2 Haftungsausschluž C.3 Warenzeichen 1 Einleitung ============ 1.1 Vorwort ----------- UDO (der Name entspringt von Universal DOcument) ist ein Programm, wel- ches Text-Dateien mit speziellen Kommandos komplett selbst forma- tiert, auf Wunsch Titelseite und Inhaltsverzeichnis erzeugen kann und dann in folgende Formate umwandeln kann: 1. ASCII 2. ST-Guide-Quelltext 3. LaTeX-Quelltext 4. Rich Text Format 5. Pure-C-Help-Quelltext 6. 1st Wordplus Die von UDO benutzen Kommandos „hneln sehr stark denen von LaTeX und den HCP-Kommandos des ST-Guide. Wer also schon einmal mit TeX gearbei- tet hat bzw. einen Hypertext geschrieben hat, der wird sehr schnell mit UDO zurechtkommen. UDO richtet sich an alle Personen, die Anleitungen oder sonstige Texte in mehreren Formaten weitergeben m”chten. Falls Du eine der folgenden Fragen mit "Ja" beantworten kannst, dann drfte UDO genau das richtige fr Dich sein: ù Du programmierst und ben”tigst neben der ASCII-Anleitung noch einen Hypertext fr den ST-Guide? ù Du programmierst und m”chtest das Handbuch mit TeX oder einer Textverarbeitung, die RTF importieren kann, setzen? ù Du bist der Autor einer Pure-C-Library und m”chtest die Beschrei- bung der einzelnen Routinen neben einer ASCII-Datei auch als ST- Guide-Hypertext und als spezielle Hilfedatei im PC-Help-Format anbieten? ù Du brauchst zwar nur eine ASCII-Anleitung, m”chtest aber die Ka- pitel nicht immer manuell durchnumerieren. Aužerdem willst Du Dir ein Inhaltsverzeichnis automatisch ausgeben lassen k”nnen? ù Du bist jemand, der ”fters an Texten etwas „ndert und dadurch jedesmal Abs„tze neu formatieren muž? ù Du bist ein Mauser, saugst eh alles und Du mužt eh alles einmal ausprobieren? ;-) Wenn Du keine Frage mit "Ja" beantworten konntest, dann drfte UDO nichts fr Dich sein und Du kannst Dir das Weiterlesen dieser Anlei- tung sparen. 1.2 UDOs Geschichte ------------------- Ende 1994 hatte ich ein paar Programme (die Spiele der "Play it again, GEM!"-Reihe) fertiggestellt, die die Untersttzung des ST-Guide einge- baut hatten. Fr diese Programme ben”tige ich nun also einen Hyper- text, eine Anleitung im ASCII-Format sowie eine gedruckte Anleitung. Und schon stand ich vor dem Problem: wie sollte ich die Anleitungen erstellen? 1. Als reine ASCII-Datei, dann die Hypertextkommandos einfgen und in Papyrus importieren und neu formatieren? 2. Als Hypertext und dann die Hypertextkommandos filtern und im letzten Schritt wieder in Papyrus importieren und neu for- matieren? 3. Mit Papyrus, dann als ASCII exportieren, neu formatieren, da man ja einen Proportionalfont benutzt und der ASCII-Export entspre- chend scheužlich aussieht und dann wieder im letzten Schritt die Hypertextkommandos einfgen? Ich habe schnell feststellen k”nnen, daž das auf Dauer keine Zumutung ist und ich mužte mir etwas berlegen. Aužerdem hatte ich in der Zwischenzeit TeX entdeckt; ein neues Format kam auf mich zu. ;-) Grbel, grbel und studier; Anfang Januar 1995 war es dann soweit. Ein bižchen nachgedacht (ja, wirklich, nicht sofort losgehacked) und das erste Ergebnis Dirk Haun pr„sentiert, der sofort begeistert von der Idee war und auch gleich einen Haufen Wnsche hatte und Verbesse- rungsvorschl„ge machte. UDO war geboren... Nun haben wir Ende April und es hat sich gegenber dem 2. Release einiges getan. Wenn ich "einiges" sage, dann meine ich das auch. Alleine die Tatsache, daž die Historie zu UDO in ein eigenes Dokument ausgelagert wurde, spricht schon B„nde. 1.3 UDO's Zukunft ----------------- UDO wird demn„chst noch wesentlich mehr k”nnen und auch auf anderen Rechnersystemen als dem Atari verfgbar sein. Geplant sind unter anderem 1. eine Umgebung fr Tabellen, 2. die korrekte Ausgabe von 1stWord-Dokumenten, 3. die Hypertext-Markup-Language (HTML) als Ausgabeformat, 4. Winhelp-Quelltexte als Ausgabeformat, 5. Wandlung der Dokumente im RAM, 6. UDO fr Linux (die erste Version wurde bereits compiliert, aber noch nicht getestet), 7. UDO fr DOS, 8. UDO fr OS/2, 9. und wenn sich ein spezieller Herr endlich dazu entschliežen wrde, sich einen ANSI-C-Compiler fr seine HP-Apollo zuzulegen, auch ein UDO fr HP-UX. 1.4 šber diese Anleitung ------------------------ Diese Anleitung wurde vor der Ver”ffentlichung des Release 3 komplett neu geschrieben. Die alte Anleitung war nicht mehr tragbar, da zu unbersichtlich. In dieser Anleitung wird man zum einen etwas ber UDO, dem Format erfahren sowie etwas ber die Bedienung von UDO, dem Programm. Im folgenden werde ich jeweils "Abkrzungen" benutzen. Falls z.B. "fr den ST-Guide" zu lesen ist, dann bedeutet dies soviel wie "fr die Wandlung in einen Hypertext-Quelltext fr den ST-Guide". Oder: "bei RTF" bedeutet dann soviel wie "bei der Wandlung ins RTF-Format". Ich denke, Ihr werdet schon verstehen, was ich jeweils meine. Ich bitte darum, etwaige Rechtschreibfehler zu entschuldigen und mir zu melden, damit ich diese verbessern kann. Nobody's perfect! ;-) Falls etwas in dieser Anleitung zu undurchsichtig oder zu kompliziert erkl„rt worden ist, so hilft meist ein Blick in 'UDO.U', dem Quell- text dieser Anleitung. Hier sind alle m”glichen Befehle mindestens einmal benutzt worden. So wie UDO selbst an LaTeX angelehnt ist, so ist auch der Aufbau dieser Anleitung an ein Standardwerk fr LaTeX angelehnt. Hierbei handelt es sich um "LaTeX-Einfhrung Band 1" von Helmut Kopka, erh„lt- lich im Addison-Wesley-Verlag (ISBN 3-89319-664-1). Jedem, der sich ein bižchen fr TeX interessiert, m”chte ich dieses Buch besonders ans Herz legen! 1.5 Bekannte M„ngel und Probleme -------------------------------- UDO ist nicht perfekt. Hier eine Auflistung aller derzeit bekannter M„ngel: 1. Die 1stWord-Ausgabe ist immer noch etwas daneben. Es fehlen noch das Lineal sowie weitere Dinge. Sorry, dazu bin ich in der Eile nicht mehr gekommen. Deshalb ist der Button in der GEM-Shell auch nicht anw„hlbar. 2. Wenn man Freedom als Fileselector benutzt, sollte man UDOs Fens- ter tunlichst nicht verschieben, solange Freedom ge”ffnet ist. Tut man es doch, so wird man mit nicht weniger als zwei Redraw- fehlern bestraft, sobald man Freedom beendet. 3. Das Iconifying funktioniert in der GEM-Shell nicht unter MagiC3. Der Fehler ist bekannt und wird demn„chst behoben sein. 4. (hopefully not to be continued...) Folgende Probleme sind nicht udo-spezifisch, sondern haben eine an- dere Ursache. 1. Das Problem mit Freedom haben auch andere Programme. ;-) 2. Atari Works mag die von UDO erzeugten RTF-Files nicht importie- ren und sagt nur lapidar "Fehler beim Laden der Datei". Ich tippe darauf, daž Works nicht mit den Zeilenenden zurechtkommt, obwohl lauft RTF-Spezifikation ASCII 13 ignoriert werden muž. Beschwert Euch bei Atari, beim Generalvertrieb oder direkt in Indien. ;-) 3. Tempus Word soll ebenso Probleme beim RTF-Import haben. Woran das liegt, kann ich ohne Tempus Word schlecht beurteilen. UDO be- nutzt nur Befehle, wie sie auch in der RTF-Spezifikation angege- ben sind. Wenn Tempus Word damit dann nicht klarkommt, dann ist das nicht UDO's oder meine Schuld, sondern es liegt an der man- gelhaften RTF-Einbindung. Beschwert Euch also bitte bei CCD und nicht bei mir. 4. Papyrus 3.11 untersttzt nicht den RTF-Befehl '\line', weshalb das UDO-Kommando '(!nl)' nicht korrekt umgesetzt wird. 2 Shareware =========== Und schon sind wir beim leidigen Thema angekommen.... UDO ist Shareware und kostet 30 DM inkl. Mehrwertsteuer (dieser Preis ist eigentlich ein Witz, wenn man mal bedenkt, was UDO alles leistet und was UDO einem alles an Arbeit erspart). UDO ist in der vorliegenden Kommandozeilenversion nicht einge- schr„nkt. Da die Hauptanwendergruppe fr UDO gr”žtenteils aus Hand- buch und Programmautoren bestehen drfte und ich mir hier eine gr”že- re Zahlungsmoral erhoffe als beim grožen Rest der heimlichen Anwender- schar, habe ich hier auf grožartige Einschr„nkungen und Registrie- rungsverfahren verzichtet. Sollte ich wider Erwarten kaum Resonanz in Form von Registrierungen bekommen, werde ich entweder 1. UDO zur Crippleware machen (etwa mit h„žlichen Warteschleifen, begrenzten Dokumentgr”žen, vertauschten Buchstaben in der Ziel- datei, ...) oder 2. die Weiterentwicklung von UDO komplett einstellen oder 3. neue Versionen nicht mehr ver”ffentlichen und nur noch an regis- trierte Anwender herausgeben. Das sind keine leeren Drohungen, das ist mein Ernst. Ich bin in der Vergangenheit bereits oft genug entt„uscht worden. Manche m”gen ange- sichts dieser Worte schmunzeln; ich kann darber gar nicht mehr lachen. Nach erfolgter Registrierung erh„lt man von mir eine Rechnung, um den Kauf von UDO steuerlich absetzen zu k”nnen, sowie den Schlssel zur Registrierung der eingeschr„nkten GEM-Shell. Und so wird man registrierter Benutzer von UDO... Den Shareware-Beitrag von 30 DM (wer mehr spenden will, kann das gerne tun ;-)) kann man mir folgendermažen zukommen lassen: 1. Durch šberweisung auf mein Konto. Bitte dabei m”glichst die kom- plette Anschrift auf dem šberweisungstr„ger und "UDO" als Stich- wort angeben, damit ich die šberweisung korrekt zuordnen kann. Zus„tzlich sollte man eine Postkarte oder eine PM per EMail an mich schicken, anhand derer man mich informiert, daž man die šberweisung vorgenommen hat. 2. Durch Zusendung eines Verrechnungsschecks, ausgestellt auf 30 DM. 3. Durch Zusendung des Geldes per Brief. Am besten ist es, das Geld dann per Einschreiben zu verschicken, damit man sicher gehen kann, daž das Geld auch mir angekommen ist. Hier meine Anschrift und meine Bankverbindung: Dirk Hagedorn In der Esmecke 9 D-59846 Sundern Sparkasse Arnsberg-Sundern Konto 3 561 164 Bankleitzahl 466 500 05 MausNet: Dirk Hagedorn @ MK2 3 Manualpage ============ NAME udo - Konvertiert *.u-Dateien nach ASCII, ST-Guide, TeX, 1st Wordplus, RTF und Pure-C-Help SYNOPSIS udo [-a][-h][-l][-o F][-p][-r][-s][-t][-w] datei ... BESCHREIBUNG udo wandelt ASCII-Files im eigenen Format in eines der gewnsch- ten Zielformate udo liest dabei zeilenweise die angegebe(n) Datei(en) und gibt das Ergebnis auf STDOUT aus. OPTIONEN -a, -A, --ascii Ausgabe des Ergebnisses im ASCII-Format. -h, -H, --hold Am Ende auf Tastendruck warten. -l Unterdrckt das Anlegen eines Logfiles. -o F, -O F, --outfile F UDO's Ausgaben werden in die Datei F geschrieben (ohne vorhe- rige Sicherheitsabfrage, ob dieses File bereits existiert!). -p, -P, --pchelp Ausgabe des Ergebnisses im Pure-C-Help-Quelltext-Format. -r, -R, --rtf Ausgabe des Ergebnisses im Rich Text Format. -s, -S, --stg Ausgabe des Ergebnisses im ST-Guide-Quelltext-Format. -t, -T, --tex Ausgabe des Ergebnisses im LaTeX-Format. -w, -W, --1wp Ausgabe des Ergebnisses im 1stWord-Format. --help Gibt Hilfstext aus. --version Gibt Programmversion aus. BEISPIEL udo foo.u Wandelt foo.u ins ASCII-Format und gibt auf die Standardausga- be aus. udo -t -h foo.u Wandelt foo.u ins LaTeX-Format und gibt auf die Standardausga- be aus. Am Ende wird auf einen Tastendruck gewartet. udo -s -o h:\temp\foo.stg foo.u Wandelt foo.u ins ST-Guide-Format und schreibt das Ergebnis in die Datei h:\temp\foo.stg. udo --stg --outfile h:\temp\foo.stg foo.u Identisch mit dem vorherigen Beispiel. EXIT STATUS ù 0 Alles in Ordnung. ù >0 Es ist ein Fehler aufgetreten. AUTOR Copyright (c) 1995 by Dirk Hagedorn Software 4 Grundlagen ============ 4.1 Textaufbau -------------- 4.1.1 Worte, Abs„tze & Kapitel Ein Text setzt sich aus Worten, S„tzen, Abs„tzen, Abschnitten und Ka- piteln zusammen. Worte bilden S„tze, S„tze bilden Abs„tze, mehrere Abs„tze bilden Ab- schnitte und/oder Kapitel. Ein Wort besteht aus einem oder mehreren Zeichen, von denen keines ein Leerzeichen oder ein Tabulator ist. Mehrere Worte bilden einen Satz. Zwei Worte werden durch ein oder mehrere Leerzeichen bzw. einen oder mehrere Tabulatoren voneinander getrennt. Ein Absatz besteht aus einem oder mehreren S„tzen. Abs„tze werden durch eine oder mehrere Leerzeile(n) voneinander getrennt. Ein Abschnitt oder Kapitel besteht aus einem oder mehreren Abs„tzen. Ein Wort darf bei UDO maximal 80 Zeichen lang sein. Die Anzahl an Worten innerhalb eines Absatzes ist nicht eingeschr„nkt, ebensowenig die Anzahl an Abs„tzen innerhalb eines Abschnitts oder eines Kapi- tels. 4.1.2 Vorspann & Hauptteil Jeder Text, der von UDO bearbeitet werden soll, muž sich in zwei Teile teilen: 1. Vorspann Im Vorspann k”nnen Angaben zum Autor und Inhalt des Textes ge- macht werden, mssen u.U. spezielle Befehle fr LaTeX (\documentstyle, ...), RTF (!rtf_propfont, ...) oder den ST- Guide (@subject, ...) eingefgt werden. 2. Hauptteil Der Hauptteil muž immer mit '!begin_document' und '!end_document' geklammert werden und enth„lt den eigentlichen Inhalt der Anleitung. 4.1.3 Kommentare Ein Text darf Kommentare enthalten. Eine Zeile gilt dann als Kommen- tar, wenn das erste Zeichen dieser Zeile ein '#' ist. Eine Zeile mit einem Kommentar wird nicht beachtet und ausgegeben. Keine Regel ohne Ausnahme: Innerhalb einer Verbatim-Umgebung werden auch Kommentare ausgegeben! 4.2 Befehle ----------- Innerhalb eines Textes bedarf es spezieller Befehle, anhand derer UDO erkennen kann, wie dieser Text zu strukturieren und zu formatieren ist. Ein Befehl beginnt jeweils mit '!' bzw. mit '(!'. Da das '!' als Metazeichen zu Beginn eines Wortes normalerweise keine Verwendung findet, ist die Verwendung unproblematisch. Das Metazeichen muž generell nicht gequotet werden. Nur dann, wenn man einen UDO-Befehl selbst in einem Text verwenden will, so muž man das Metazeichen durch '!/' gequotet werden, wie z.B. dann, wenn man das Kommando '!/tableofcontents' selbst benutzen m”chte. 4.3 Bedingte Befehle -------------------- Manchmal m”chte man spezielle Zeilen nur bei einem Zielformat ausge- ben. Hierfr existieren folgende Befehle: '!asc ...', '!pch ...', '!rtf ...', '!stg ...', '!tex ...', '!1wp ...' und '!html ...' Trifft UDO am Anfang einer Zeile auf solch einen Befehl, so gibt er den Rest der Zeile nur aus, wenn man nach ASCII, PC-Help, RTF, ST- Guide, TeX oder 1stWord wandelt. Durch Verwendung dieser Befehle lassen sich sehr einfach spezielle Dinge wie die Grafikeinbindung bei TeX oder beim ST-Guide oder wie das Hinzufgen zus„tzlicher spezieller Kommandos l”sen. Im anderen Falle m”chte man spezielle Zeilen nicht bei allen Zielfor- maten ausgeben. Hierfr existieren analog folgende Befehle: '!=asc ...', '!=pch ...', '!=rtf ...', '!=stg ...', '!=tex ...', '!=1wp ...' und '!=html ...' Trifft UDO am Anfang einer Zeile auf solch einen Befehl, so gibt er den Rest der Zeile immer dann aus, wenn man nicht nach ASCII, PC- Help, etc. wandelt. Vorsicht! Der Rest der Zeile, der einem bedingten Befehl folgt, wird nicht umgewandelt! Das bedeutet, daž man keine UDO-Kommandos, UDO- Textstile etc. benutzen kann! 4.4 Umgebungen -------------- UDO verwendet zur Formatierung des Texts genau wie LaTeX sogenannte "Umgebungen". Abs„tze, die innerhalb einer solchen Umgebung stehen, werden dabei besonders formatiert. Eine Umgebung wird durch '!begin_...' eingeleitet und durch '!end_...' beendet. Ob eine Umgebung schachtelbar ist und wie die Abs„tze innerhalb einer Umgebung formatiert wird, findet man in den speziellen Kapiteln. 4.5 Sonderzeichen ----------------- Die Zeichen '# $ & _ ^ % { } \' haben fr TeX und RTF eine spezielle Bedeutung. Damit bei einem TeX-Lauf bzw. beim Compilieren des Pure-C-Helpfiles keine Fehlermeldungen auftreten, mssen diese Sonderzeichen mit Aus- nahme der Tilde durch '!' gequotet werden, solange diese Zeichen nicht innerhalb einer Verbatim-Umgebung oder zwischen '(!V)...(!v)' stehen! Anstelle des Anfhrungszeichens '"' sollte man in einem Text immer doppelte Anfhrungszeichen '""' benutzen. UDO wandelt diese doppelten Anfhrungszeichen fr TeX und RTF in die korrekten deutschen (ja, ja, immer diese korrekten Deutschen ;-)) Anfhrungsstriche. Bei allen anderen Formaten werden die doppelten wieder durch die einfachen Anfhrungszeichen ersetzt. Wer nur fr sich selbst Texte im ASCII- und ST-Guide-Format erzeugt, braucht die Sonderzeichen nicht zu quoten bzw. doppelte Anfhrungszei- chen benutzen. Wer allerdings seine Dokumentation auch im UDO-Format weitergeben m”chte, sollte Sonderzeichen immer quoten und auch immer doppelte Anfhrungszeichen benutzen! 5 Gliederung ============ Jede vernnftige Anleitung l„žt sich fr gew”hnlich in eine Titelsei- te, ein Inhaltsverzeichnis, Kapitel, Abschnitte, Unterabschnitte und einen Anhang unterteilen. 5.1 Titelseite -------------- UDO kann durch '!maketitle' automatisch eine Titelseite erzeugen. Dazu mssen im Vorspann die Angaben fr '!author', '!street', '!town', '!email', '!title', '!program', '!version' und '!date' ganz oder auch nur teilweise stehen. Bei der Wandlung ins ST-Guide-Format wird die Titelseite hingegen nicht sofort erzeugt, sondern erst bei '!tableofcontents'. Intern wird also lediglich vermerkt, daž der erste Node Titelangaben und In- haltsverzeichnis enthalten soll. 5.2 Inhaltsverzeichnis ---------------------- Der Befehl '!tableofcontents' wird von UDO durch ein automatisch generiertes Inhaltsverzeichnis ersetzt (nicht fr TeX und RTF). Da dieses Inhaltsverzeichnis durchaus einigen Umfang erhalten kann, kann man durch den Befehl '_short_toc', der irgendwann vor '!tableofcontents' auftauchen muž, ein kurzes Inhaltsverzeichnis aus- geben lassen. Die krzere Version besteht nur noch aus den Kapitelna- men; Abschnitte und Unterabschnitte werden also nicht bercksichtigt. Durch '!short_toc' erh„lt man immer ein kurzes Inhaltsverzeichnis. M”chte man jedoch bei der ASCII-Anleitung ein langes und beim ST- Guide ein kurzes Inhaltsverzeichnis haben, so muž man folgende Befeh- le anwenden: '!asc_short_toc', '!pch_short_toc', '!stg_short_toc' sowie '!1wp_short_toc' Steht nun im Text z.B. der Befehl '!stg_short_toc', so wird bei der Wandlung nach ST-Guide ein kurzes Inhaltsverzeichnis ausgegeben, bei allen anderen Formaten jeweils ein komplettes Inhaltsverzeichnis. Wenn man nun ein kurzes Inhaltsverzeichnis benutzt, muž man dafr sorgen, daž man im Hypertext oder im PC-Helpfile auch zu den Abschnit- ten und Unterabschnitten weiterverzweigen kann. Dies ist durch die Be- fehle '!subtoc' und '!subsubtoc' m”glich. Durch '!subtoc' erh„lt an der aktuellen Position alle zum aktuellen Kapitel zugeh”rigen Abschnitte aufgelistet, durch '!subsubtoc' ana- log alle zum aktuellen Abschnitt zugeh”rigen Unterabschnitt. M”chte man wie im obigen Beispiel nur beim ST-Guide ein Unter-In- haltsverzeichnis, so l„žt sich dies durch die Befehle '!stg_subtoc' und '!stg_subsubtoc' l”sen. Fr die anderen Formate existieren die Befehle '!asc_subtoc', '!asc_subsubtoc', '!pch_subtoc', '!pch_subsubtoc', '!1wp_subtoc' und '!1wp_subsubtoc' natrlich auch. 5.3 Kapitel, Abschnitte und Unterabschnitte ------------------------------------------- '!node' leitet ein Kapitel ein. '!subnode' leitet einen Abschnitt ein. '!subsubnode' leitet einen Unterabschnitt ein. Alles, was nach diesem Befehl folgt, wird in das Inhaltsverzeichnis bernommen. Fr TeX , RTF, PC-HELP und ST-Guide werden die speziellen Befehl bzw. Absatzformate eingefgt. 5.4 Anhang ---------- Der Anhang wird durch den Befehl '!begin_appendix' eingeleitet und mit '!end_appendix' beendet. Kapitel, die innerhalb der Appendix-Umgebung stehen, werden mit Grož- buchstaben durchnumeriert. Pro Dokument ist nur ein Anhang m”glich! 6 Formatierung ============== UDO kmmert sich komplett um die Formatierung des Textes. UDO ist es v”llig egal, wie lang (na ja, nicht ganz, l„nger als 4092 Zeichen darf eine Zeile nicht sein) eine Zeile Deines Quelltextes ist, durch wie- viele Leerzeichen und TABs die Worte eingerckt sind und durch wie- viele Leerzeilen die Abs„tze voneinander getrennt sind. UDO bricht Abs„tze generell auf eine L„nge von 70 Zeichen um. Texte mit einer Breite von 70 Zeichen lassen sich bequem ausdrucken und auch auf in der hohen ST-Aufl”sung vernnftig lesen. Fr TeX und RTF spielt der Umbruch eh keine Rolle, da hier die Formatierung von TeX selbst bzw. von der Textverarbeitung bernommen wird. 6.1 Žnderungen der Schrift -------------------------- UDO beinhaltet Kommandos zur Žnderungen der Schrift bzw. des Schrift- stils. Diese Kommandos werden bei der Wandlung in ein Format entspre- chend umgesetzt bzw. gefiltert, falls das Format einen solchen Stil nicht kennt. An Stilen stehen zur Verfgung: (!B)...(!b) -> bold (fett) (!U)...(!u) -> underlined (unterstrichen) (!I)...(!i) -> italic (kursiv bzw. schr„g) (!V)...(!v) -> verb (Schreibmaschinenschrift fr TeX, RTF) (!F)...(!f) -> fbox (nur fr TeX) Beispiele: fett unterstrichen kursiv verb fbox 6.2 Textverschiebungen ---------------------- UDO beherrscht momentan nur eingerckten Text. Zentrierter Text und Blocksatz folgen demn„chst. 6.2.1 Zentrierter Text Demn„chst... 6.2.2 Eingerckter Text Durch die Quote-Umgebung, die durch '!begin_quote' und '!end_quote' gebildet wird, werden Abs„tze innerhalb dieser Umgebung nach rechts eingerckt. Diese Umgebung ist bis zu viermal schachtelbar. Ein Beispiel: Dies ist ein Satz, der innerhalb der ersten Quote-Umgebung steht. Dies ist ein Satz, der innerhalb der zweiten Quote-Umgebung steht. Dies ist ein Satz, der innerhalb der dritten Quote-Umge- bung steht. Dies ist ein Satz, der innerhalb der vierten Quote-Um- gebung steht. Auch dieser Satz steht innerhalb der vierten Quote-Um- gebung. Dies ist wieder die dritte Quote-Umgebung. Dies ist wieder die zweite Quote-Umgebung. Dies ist wieder die erste Quote-Umgebung. Dieses Beispiel wurde folgendermažen erzeugt: !begin_quote Dies ist ein Satz, der innerhalb der ersten Quote-Umgebung steht. !begin_quote Dies ist ein Satz, der innerhalb der zweiten Quote-Umgebung steht. !begin_quote Dies ist ein Satz, der innerhalb der dritten Quote-Umgebung steht. !begin_quote Dies ist ein Satz, der innerhalb der vierten Quote-Umgebung steht. Auch dieser Satz steht innerhalb der vierten Quote-Umgebung. !end_quote Dies ist wieder die dritte Quote-Umgebung. !end_quote Dies ist wieder die zweite Quote-Umgebung. !end_quote Dies ist wieder die erste Quote-Umgebung. !end_quote 6.3 Aufz„hlungen ---------------- Fr Aufz„hlungen stehen genau wie in LaTeX folgende Umgebungen zur Verfgung: ù '!begin_itemize' ... '!end_itemize' ù '!begin_enumerate' ... '!end_enumerate' ù '!begin_description' ... '!end_description' Der aufzuz„hlende Text, der innerhalb dieser Umgebungen steht, wird eingerckt und mit einer Markierung versehen. Der aufzuz„hlende Text kann beliebig lang sein. Die einzelnen Aufz„hlungen werden jeweils durch Leerzeilen voneinander getrennt. Die Umgebungen drfen bis zu viermal (auch gemischt) geschachtelt werden. Zur Kennzeichnung einer Aufz„hlung wird der Befehl '!item ...' be- nutzt. Bei der Description-Umgebung kann wahlweise aužerdem der Befehl '!item [...] ...' verwendet werden. Alles, was hier in eckigen Klam- mern steht, wird bei der Aufz„hlung in Fettschrift ausgegeben. 6.3.1 Beispiel 'itemize' ù Die erste Stufe bekommt einen dicken Punkt. - Die zweite Stufe bekommt einen Strich. * Die dritte Stufe bekommt einen Stern. . Die vierte Stufe bekommt einen Punkt '.'. . Selbstverst„ndlich werden Abs„tze innerhalb dieser Umge- bung auch in der vierten Stufe korrekt dargestellt. * Selbstverst„ndlich werden Abs„tze innerhalb dieser Umge- bung auch in der dritten Stufe korrekt dargestellt. - Selbstverst„ndlich werden Abs„tze innerhalb dieser Umgebung auch in der zweiten Stufe korrekt dargestellt. ù Selbstverst„ndlich werden Abs„tze innerhalb dieser Umgebung auch in der ersten Stufe korrekt dargestellt. ù Leerzeilen zwischen Aufz„hlungen haben keine Wirkung. Dieses Beispiel wurde erzeugt durch: !begin_itemize !item Die erste Stufe bekommt einen dicken Punkt. !begin_itemize !item Die zweite Stufe bekommt einen Strich. !begin_itemize !item Die dritte Stufe bekommt einen Stern. !begin_itemize !item Die vierte Stufe bekommt einen Punkt ''(!V).(!v)''. !item Selbstverst„ndlich werden Abs„tze innerhalb dieser Umgebung auch in der vierten Stufe korrekt dargestellt. !end_itemize !item Selbstverst„ndlich werden Abs„tze innerhalb dieser Umgebung auch in der dritten Stufe korrekt dargestellt. !end_itemize !item Selbstverst„ndlich werden Abs„tze innerhalb dieser Umgebung auch in der zweiten Stufe korrekt dargestellt. !end_itemize !item Selbstverst„ndlich werden Abs„tze innerhalb dieser Umgebung auch in der ersten Stufe korrekt dargestellt. !item Leerzeilen zwischen Aufz„hlungen haben keine Wirkung. !end_itemize 6.3.2 Beispiel 'enumerate' 1. Die Numerierung der ersten Stufe erfolgt mit arabischen Ziffern, gefolgt von einem Punkt. a) Die Numerierung der zweiten Stufe erfolgt bei UDO in Klein- buchstaben, gefolgt von einer Klammer. TeX benutzt hier auch Kleinbuchstaben, die allerdings in () gesetzt werden. 1) Die Numerierung der dritten Stufe erfolgt bei UDO mit arabischen Ziffern, gefolgt von einer Klammer. TeX benutzt hier kleine r”mische Ziffern, gefolgt von einem Punkt. A. Die Numerierung der vierten Stufe erfolgt in Grožbuch- staben, gefolgt von einem Punkt. B. Dies ist auch noch die vierte Stufe. 2) Dies ist wieder die dritte Stufe. b) Dies ist wieder die zweite Stufe. 2. Dies ist wieder die erste Stufe. 3. Leerzeilen zwischen Aufz„hlungen haben keine Wirkung. Dieses Beispiel wurde erzeugt durch: !begin_enumerate !item Die Numerierung der ersten Stufe erfolgt mit arabischen Ziffern, gefolgt von einem Punkt. !begin_enumerate !item Die Numerierung der zweiten Stufe erfolgt bei UDO in Kleinbuchstaben, gefolgt von einer Klammer. !TeX~benutzt hier auch Kleinbuchstaben, die allerdings in () gesetzt werden. !begin_enumerate !item Die Numerierung der dritten Stufe erfolgt bei UDO mit arabischen Ziffern, gefolgt von einer Klammer. !TeX~benutzt hier kleine r”mische Ziffern, gefolgt von einem Punkt. !begin_enumerate !item Die Numerierung der vierten Stufe erfolgt in Grožbuchstaben, gefolgt von einem Punkt. !item Dies ist auch noch die vierte Stufe. !end_enumerate !item Dies ist wieder die dritte Stufe. !end_enumerate !item Dies ist wieder die zweite Stufe. !end_enumerate !item Dies ist wieder die erste Stufe. !item Leerzeilen zwischen Aufz„hlungen haben keine Wirkung. !end_enumerate 6.3.3 Beispiel 'description' Die Description-Umgebung eignet sich besonders fr ein Glossar, fr Danksagungen oder die Erkl„rung von Funktionsparametern innerhalb eines Pure-C-Helpfiles. An dieser Stelle dient als Beispiel ein wenig Eigenwerbung ;-): Play it again, GEM! ist eine Reihe von sauberen GEM-Spielen, die un- ter allen TOS-Betriebssystemen, ab 640 x 400 Punkten mit beliebi- ger Farbtiefe auch auf Grafikkarten laufen. Die Spiele sind er- h„ltlich bei Delta Labs Media und Dirk Hagedorn Software. Tricky ist eine GEM-Version von "Kniffel", dem bekannten und belieb- ten Wrfelspiel. "Tricky" ist Shareware und kostet nur 15 DM. Don't worry, be happy ist eine GEM-Version des Brettspiels "Mensch „rgere Dich nicht", ist Shareware und kostet nur 15 DM. MoveIt ist eine GEM-Version des Geduldspiels "Sokoban", bietet 50 Level und kostet nur 10 DM. Nanjing ist eine GEM-Version von "Huang Shi" bzw. "Shih Tao" und kostet nur 15 DM. Auch ein normales '!item' ist m”glich. Leerzeilen bewirken nichts. Dieses Beispiel wurde erzeugt durch: !begin_description !item [Play it again, GEM!] ist eine Reihe von sauberen GEM-Spielen, die unter allen TOS-Betriebssystemen, ab 640~x~400 Punkten mit beliebiger Farbtiefe auch auf Grafikkarten laufen. Die Spiele sind erh„ltlich bei Delta Labs Media und Dirk Hagedorn Software. !item [Tricky] ist eine GEM-Version von ""Kniffel"", dem bekannten und beliebten Wrfelspiel. ""Tricky"" ist Shareware und kostet nur 15~DM. !item [Don't worry, be happy] ist eine GEM-Version des Brettspiels ""Mensch „rgere Dich nicht"", ist Shareware und kostet nur 15~DM. !item [MoveIt] ist eine GEM-Version des Geduldspiels ""Sokoban"", bietet 50 Level und kostet nur 10~DM. !item [Nanjing] ist eine GEM-Version von ""Huang Shi"" bzw. ""Shih Tao"" und kostet nur 15~DM. !item Auch ein normales ''(!V)!/item(!v)'' ist m”glich. Leerzeilen bewirken nichts. !end_description 6.4 Ausgabe von Originaltext ---------------------------- Manchmal m”chte man Textabschnitte so ausgeben, wie sie im Text ste- hen. Ein Beispiel ist z.B. ein Teil eines Sourcecodes eines Pro- gramms. Fr diesen Zweck gibt es in UDO wie auch in TeX die Verbatim-Umge- bung, welche durch die Befehle '!begin_verbatim' und '!end_verbatim' gekennzeichnet wird. Alles, was zwischen diesen beiden Befehlen steht, wird ohne Bearbei- tung und ohne Formatierung, also 1:1 ausgegeben. Einrckungen der Quote-Umgebung werden jedoch bercksichtigt. 6.5 Silbentrennung ------------------ Man kann von UDO nicht erwarten, daž er eine komplette Silbentren- nung, wie man sie von TeX oder einer Textverarbeitung her kennt, bein- haltet. Allerdings kann man UDO die Silben eines Wortes durch den Trennstrich '!-' kenntlich machen. Da Bilder bekanntlich mehr als tausend Worte sagen, hier ein kleines Beispiel, in dem extralange Wortkonstrukte als Verdeutlichung dienen: Dies ist das erste Beispiel: Ein Fužballstadionflutlichtglhbirnenfassungsgewinde und noch ein Fužballstadionflutlichtglhbirnenfassungsgewinde sind zusammen zwei Fužballstadionflutlichtglhbirnenfassungsgewinde. Dies ist das zweite Beispiel: Ein Fužballstadionflutlichtglhbirnen- fassungsgewinde und noch ein Fužballstadionflutlichtglhbirnenfas- sungsgewinde sind zusammen zwei Fužballstadionflutlichtglhbirnenfas- sungsgewinde. Und so sieht das im Quelltext aus: Dies ist das erste Beispiel: Ein Fužballstadionflutlichtglhbirnenfassungsgewinde und noch ein Fužballstadionflutlichtglhbirnenfassungsgewinde sind zusammen zwei Fužballstadionflutlichtglhbirnenfassungsgewinde. Dies ist das zweite Beispiel: Ein Fuž!-ball!-sta!-dion!-flut!-licht!-glh!-bir... und noch ein Fuž!-ball!-sta!-dion!-flut!-licht!-glh!-bir... sind zusammen zwei Fuž!-ball!-sta!-dion!-flut!-licht!-glh!-bir... Beim ersten Beispiel sieht man gleich, daž das sinnlose Wort den ganzen Umbruch zerst”rt und eine absolut h„žliche Ausgabe erzeugt. Das zweite Beispiel hingegen sieht doch ganz brauchbar aus, oder? ;-) Jetzt stellen wir uns einmal vor, wir h„tten wirklich solch ein Wort- ungetm in einem unserer Quelltexte. Die dauernde erneute Angabe der Trennstriche ginge einem sicher schnell auf die Nerven. Aber es gibt Abhilfe. Durch das Kommando '!hyphen' kann man UDO sagen, daž er gef„lligst ein bestimmtes Wort immer (genauer, ab dem Auftreten von '!hyphen') auf eine bestimmte Art und Weise zu trennen hat. Im obigen Beispiel h„tte also das Einfgen des Kommandos !hyphen Fuž!-ball!-sta!-dion!-flut!-licht!-glh!-bir... dieselbe Wirkung erzielt. Probieren wir es doch einmal kurz aus: Dies ist das erste Beispiel: Ein Fužballstadionflutlichtglhbirnenfas- sungsgewinde und noch ein Fužballstadionflutlichtglhbirnenfassungsge- winde sind zusammen zwei Fužballstadionflutlichtglhbirnenfassungsge- winde. Wichtige Anmerkungen: Der !hyphen-Befehl ist nicht ganz unproblematisch und kann einem schnell einen ganzen Zieltext unbrauchbar machen: UDO speichert die mit '!hyphen' gemachten Trennvorschl„ge in einer internen Liste, welche Platz fr 256 Eintr„ge zu je 80 Zeichen bie- tet, und arbeitet diese nach dem FIFO-Prinzip ab (FIFO bedeutet "first in first out"). Bei der Ausgabe eines Wortes schaut UDO dann in der internen Liste nach, ob ein Trennvorschlags-Muster in diesem Wort vorkommt. Falls ja, so wird dieses Muster in dem Wort eingesetzt. Bei der Verwendung der Trennvorschl„ge ist folgendes zu beachten: Plural vor Singular: 'For!-ma/te' vor 'For!-mat'. UDO wrde im um- gekehrten Falle aus 'Formate' das Wort 'For!-mate' erzeugen und wrde die letzte Silbe nicht mehr bei der Trennung bercksichtigen. Grož/Kleinschreibung beachten: 'Sei!-te' ist nicht gleich 'sei!- te'. Sparsamer Einsatz: Jeder zus„tzliche Trennvorschlag verlangsamt die Konvertierung. '!hyphen' sollte also nur bei W”rtern benutzt werden, die mindestens viermal oder ”fters im Quelltext auftre- ten. Ansonsten benutzt man besser direkt im Quelltext die Trennstriche. Rechtzeitiger Einsatz: Ein Trennvorschlag wir bei der Konvertierung erst ab der Stelle beachtet, bei dem er angegeben wurde. Trennvor- schl„ge setzte man daher am besten an den Anfang des Quelltextes bzw. lagert sie in eine eigene Datei aus und bindet diese per '!include' gleich am Anfang des Quelltextes ein. 6.6 Zeilenumbruch ----------------- UDO formatiert den Text eigenst„ndig und trennt Abs„tze durch Leerzei- len. Man h„tte also keine M”glichkeit, einen Zeilenumbruch zu erzwin- gen, wrde es nicht den Befehl '(!nl)' geben. Durch '(!nl)' erh„lt man also die M”glichkeit, einen Absatz an belie- biger Stelle aufzubrechen. Obiges Beispiel wurde erzeugt durch: Durch ''(!V)(!/nl)(!v)'' erh„lt man also die M”glichkeit, einen Absatz an beliebiger (!nl) Stelle aufzubrechen. Ein weiteres Einsatzgebiet ist z.B. der erzwungene Zeilenumbruch bei den Itemize-Umgebung: ù Hier steht Bl”dsinn Hier auch. ù Und hier erst Besser wird's nicht... Dieses Beispiel wiederum wurde folgendermažen erzeugt: !begin_itemize !item Hier steht Bl”dsinn (!nl) Hier auch. !item Und hier erst (!nl) Besser wird's nicht... !end_itemize 6.7 Seitenumbruch ----------------- Durch den Befehl '!newpage' kann man TeX und RTF dazu zwingen, den folgenden Text auf eine neue Seite zu positionieren. Bei der Wandlung nach 1stWord wird '!newpage' durch einen Formfeed (ASCII 12) ersetzt. Bei allen anderen Zielformaten wird '!newpage' gefiltert. 7 Grafikeinbindung ================== UDO kann die Einbindung von GEM-Images fr den ST-Guide, das CS-TeX und das Lindner-TeX umsetzen. Das Bild wird dabei jeweils zentriert und mit der (optionalen) Bildunterschrift versehen. Fr die Einbindung sorgt '!image F [B]'. 'F' ist dabei der Dateiname des GEM-Images, 'B' die optionale Bildunterschrift. Hier ein Beispiel: Dieses Beispiel wurde erzeugt mit... !tex_lindner !tex_dpi 100 !image img\tiger.img Ein GEM-Image 7.1 Grafikeinbindung fr den ST-Guide ------------------------------------- UDO ermittelt zun„chst die Breite und H”he des Bildes, gibt eine '@image'-Zeile so aus, daž das Bild zentriert dargestellt wird und fgt dann noch in der erzeugten STG-Datei die n”tige Anzahl an Leer- zeilen ein. Die Zentrierung des Bildes und die Anzahl der Leerzeilen beziehen sich dabei auf die Ausmaže des 10pt-Systemfonts. Wurde eine Bildunterschrift angegeben, so wird diese ebenfalls zen- triert direkt unterhalb des Bildes ausgegeben. 7.2 Grafikeinbindung fr das Lindner-TeX ---------------------------------------- Damit UDO weiž, daž die Grafikeinbindung fr das CS-TeX erzeugt wer- den soll, muž man im Quelltext '!tex_lindner' angeben. Aužerdem muž im Vorspann des Quelltextes !tex \input graphic eingefgt werden. Dem Lindner-TeX liegt ein Utility namens 'IMGTOTEX' bei, mit dem man die Aufl”sung eines Bildes „ndern und eine dem Bild zugeh”riges Makro zur Einbindung erzeugen kann. 'IMGTOTEX' wird fr UDO nicht mehr ben”tigt, denn UDO bernimmt vollst„ndig seine Funktion. Durch den Befehl '!tex_dpi XXX' bestimmt man die Aufl”sung der fol- genden Bilder. UDO liest zun„chst den Header des Images aus, ber- prft dessen Aufl”sung und schreibt - falls n”tig - die neue Aufl”- sung in den Header. Defaultm„žig steht die Aufl”sung auf 100dpi. Sie kann vor jedem Bild neu gesetzt werden. Zur eigentlichen Einbindung wird dann ein passendes Makro fr das Lindner-TeX geschrieben, das Ganze in eine Figure-Umgebung gepackt und falls eine Bildunterschrift angegeben wurde, diese als '\caption' in die Figure-Umgebung gesetzt. 7.3 Grafikeinbindung fr das CS-TeX ----------------------------------- Damit UDO weiž, daž die Grafikeinbindung fr das CS-TeX erzeugt wer- den soll, muž man im Quelltext '!tex_strunk' angeben. Genau wie beim Lindner-TeX wird zur Einbindung des Images ein passen- des Makro geschrieben, das Ganze in eine Figure-Umgebung gepackt und falls eine Bildunterschrift angegeben wurde, diese als '\caption' in die Figure-Umgebung gesetzt. Auch beim Strunk-TeX wird auf die mittels '!tex_dpi' gesetzte Aufl”- sung zurckgegriffen. Da ich mich dem Strunk-TeX allerdings nicht gut auskenne, kann es sein, daž die Bildeinbindung nicht gut gel”st ist. Wenn Du mir einen Tip geben kannst, wie man es besser machen sollte, dann her damit! 8 Tips & Tricks =============== Diese Kapitel sind noch vorl„ufig und werden den„chst berarbeitet. Sobald die ersten Fragen auftauchen, werde ich dann auch genau wis- sen, was besser und genauer erkl„rt werden muž. 8.1 UDO und TeX --------------- Diese Anmerkungen wurden mir freundlicherweise von Dirk Haun zur Verfgung gestellt: Durch die Verwendung von UDO kommt so mancher Autor m”glicherweise zum ersten Mal in seinem Leben mit TeX in Berhrung. Und da nicht jeder ein lauff„higes TeX bei sich installiert hat, um die von UDO erzeugten TeX-Files auch zu testen, sollen hier ein paar Hinweise gegeben werden, worauf man in diesem Zusammenhang unbedingt achten sollte. Einige Zeichen haben fr TeX eine spezielle Bedeutung. Man muž diese daher in einem UDO-Dokument "quoten" indem man ihnen ein Ausrufe- zeichen voranstellt, damit UDO sie bei der Wandlung nach TeX entspre- chend bercksichtigen kann. Diese Zeichen sind im einzelnen: ASCII UDO !TeX --------------- # !# \# $ !$ \$ & !& \& _ !_ \_ % !% \% { !{ \{ } !} \} Wie man sieht, sind darunter einige Zeichen, die man in einem norma- len Text verwenden wird, ohne sich weiter Gedanken darber zu machen. Also Vorsicht! Denn wenn TeX auf ein solches Zeichen an einer Stelle st”žt, an der es nicht damit rechnet, so wird es den šbersetzungslauf mit einem Fehler abbrechen. Innerhalb einer verbatim-Umgebung bzw. zwischen (!V) und (!v) braucht man diese Ersetzungen nicht vorzunehmen, da UDO dafr die ent- sprechenden TeX-Konstruktionen erzeugt. Fr TeX (genauer gesagt reden wir hier eigentlich von LaTeX) existieren einige weitere Konventionen, auf die man Rcksicht nehmen sollte. So gibt es fr drei aufeinanderfolgende Punkte (Auslassungspunkte) einen eigenen TeX-Befehl (\dots), weshalb man in einem UDO-Dokument den Be- fehl !.. verwenden sollte. Desweiteren sollte man Anfhrungszeichen immer doppelt schreiben, damit UDO sie bei der Wandlung nach TeX in die korrekten ”ffnenden und schlieženden Anfhrungszeichen (TeX-Befehle "` und "') wandeln kann. Programmautoren, die Variablen- und Dateinamen in ihren Texten verwen- den, sei empfohlen, diese in (!V) und (!v) einzuschliežen. Dies hat den doppelten Vorteil, daž so nicht nur die oben genannten Sonderzei- chen nicht geqoutet werden mssen, sondern daž diese Begriffe dann in TeX in Schreibmaschinenschrift gesetzt werden, so daž sie im Text hervorgehoben erscheinen. Aužerdem hat es sich eingebrgert, "maschi- nennahe" Textstellen in Schreibmaschinenschrift zu setzen. Man sollte es vermeiden, zus„tzliche Leerzeilen im Text mit dem UDO- Befehl (!nl) zu erzwingen - TeX akzeptiert den dadurch erzeugten Be- fehl \\ nur, wenn die aktuelle Zeile auch Text enth„lt. Will man zus„tzliche Leerzeilen zwischen zwei Abs„tzen, so verwendet man in TeX den Befehl \bigskip. Man sollte daher folgende Konstruktion ver- wenden: Dies ist der erste Absatz. !tex \bigskip !=tex Hier beginnt der zweite Absatz. Dadurch erscheinen zwischen den beiden Abs„tzen zwei Leerzeilen. 8.2 UDO und Pure-C-Help ----------------------- Das Pure-C-Help-Format (kurz: PCH) ist eigentlich nur fr Autoren einer Programmier-Bibliothek interessant. Das Pure-C-Hilfesystem drfte aužerhalb der Programmentwicklung mit Pure-C keine besondere Rolle mehr spielen, seitdem der ST-Guide seinen Siegeszug angetreten hat. Da das Pure-C-Help-Format nicht sonderlich kompliziert aufgebaut ist, gab es keinen Grund, es nicht auch als Ausgabeformat anzubieten. Beim Pure-C-Help-Format werden Seiten als sogenannte 'Screens' defi- niert. Bei jedem Screen k”nnen mehrere Referenzen ('sensitive') ange- geben werden. Innerhalb des Textes selbst werden Verweise auf diese Screens mit /# gekennzeichnet. UDO setzt generell den Namen eines Kapitels, Abschnittes oder Unterab- schnittes als 'sensitive' ein. Zus„tzlich werden alle in einem Kapi- tel, Abschnitt oder Unterabschnitt existierenden Labels eingetragen. Bei der Ausgabe einer Zeile schliežlich referenziert UDO automatisch, d.h. UDO setzt die Verweise mittels /# selbst„ndig. Um eine von UDO erzeugte Datei mit dem Helpcompiler von Pure-C (HC.PRG) bersetzen zu k”nnen, bedarf es einer Kommandodatei, welche man dem Helpcompiler als Parameter bergibt. Diese Kommandodatei legt UDO beim Wandeln nach PCH automatisch an. Diese Datei braucht man dann nur noch auf den Helpcompiler ziehen. In der GEM-Shell kann man den Helpcompiler auch als externes Programm fr PCH anmelden und dort $C in der Kommandozeile bergeben. Ein kleines Problem gibt es noch bei der Wandlung nach PCH: Borland selbst fgt mit dem Helpcompiler einen Copyright-Screen in das Help- file ein. UDO ersetzt deshalb in der Zieldatei automatisch alle "Copyright" durch "Copy-Right", damit die eigene Seite bzw. das eige- ne Label angesprungen wird. A Bezugsquellen =============== Die jeweils aktuelle Version von UDO ist beim Autor gegen Einsendung einer formatierten Diskette sowie eines adressierten und mit 2 DM frankierten Rckumschlags erh„ltlich. Besitzer eines Modems finden die aktuelle Version dieses Programms in der Maus MK2 (02371-460879) im ™ffentlichen Programmteil. Registrierte Benutzer erhalten darber hinaus die M”glichkeit, aktu- elle Betaversionen aus einem Gruppenprogrammteil der Maus MK2 zu beziehen. Der Archivname lautet jeweils "UDO??.LZH", wobei "??" durch die aktu- elle Versionsnummer ersetzt wird. Auf jeweils neue Versionen wird in der MausNet-Gruppe "ATARI.NEWS" hingewiesen. B Danksagungen ============== Klar, die ganze Programmierarbeit habe ich selbst gehabt, aber durch die tatkr„ftige Untersttzung von dritter Seite ist UDO erst zu dem geworden, was er heute ist. Deshalb m”chte ich mich an dieser Stelle bei folgenden Personen sehr herzlich bedanken bei Dirk Haun fr seine vielen Ideen, konstruktiven Kritiken, fr die TeX Hinweise und die Hilfestellung bei der Auswertung der GEM- Images (und noch vielem mehr, aber das wrde jetzt den Rahmen sprengen), Jens Brggemann fr seine wirklich interessanten Programmierhinwei- se, von denen hoffentlich in UDO4 einige Verwendung finden werden, Christoph Spengler nebst seinem siamesischem Zwilling ;-) ... Rainer Wiesenfeller, die wie am Fliežband Software und Hypertexte ver”ffentlichen und gerade schon deshalb dauernd (berechtigterwei- se) etwas an UDO auszusetzen hatten, Peter Klasen, der als erster zahlender User in die Geschichte von UDO eingehen wird, aber dessen Postbote nicht weiž, daž er auf der anderen Straženseite wohnt, Manfred Ssykor fr die nimmermden Tests, die netten Telefonate und - auch wenn es nichts mit UDO zu tun hat - die viele Mhe mit den Atari Infopages, Frank Baumgart fr die Erstellung der (kommenden) Linux-, DOS- und OS/2-Versionen Andreas Pietsch fr seine einfach geniale (genial einfache?) GEM- Library "SysGem", von deren Version 2 die Dokumentation doch wohl hoffentlich mit UDO erstellt wird, C Rechtliche Informationen ========================== C.1 Copyright ------------- Das Copyright an UDO und dieser Dokumentation liegen bei Dirk Hagedorn Software, Sundern. UDO ist Shareware und darf in der unregistrierten Version auf beliebi- ge nichtkommerzielle Weise an Dritte weitergegeben werden, wenn alle folgenden Voraussetzungen erfllt werden: ù Dem Archiv drfen keine weiteren Dateien hinzugefgt werden, insbesondere keine Mailboxwerbung und keine Werbung fr PD- Serien. ù Das Programm darf generell nur kostenlos weitergegeben werden. Der Upload in gebhrenfreie Mailboxen ist ausdrcklich erwnscht und erlaubt. ù Fr die Weitergabe auf Disketten im Rahmen einer Public-Domain- Serie drfen keine Gebhren verlangt werden, die einen Betrag von 10 DM (exklusive Versandkosten) berschreiten. ù Die Weitergabe dieses Programms als Beigabe zu einer kommerziel- len Software ist dann gestattet, solange dem Kunden keine zus„tz- lichen Kosten entstehen. ù Die Weitergabe per CD-ROM bedarf meiner schriftlichen Genehmigung. ù Das Programm darf nur mit allen zugeh”rigen Dateien und in unver- „nderter Form weitergegeben werden. Dies sind im einzelnen: ----udo3016 |----udo.ttp |----man | |----cat1 | | |----udo.1 |----doku | |----add | | |----bezug.ui | | |----distrib.ui | | |----header.ui | | |----hyphens.ui | | |----recht.ui | | |----thanx.ui | | |----udo2pch.ui | | |----udo2tex.ui | | |----udottp.ui | |----img | | |----d_main.img | | |----d_regist.img | | |----d_sett.img | | |----d_xprg.img | | |----m_datei.img | | |----m_option.img | | |----m_quelle.img | | |----m_ziel.img | |----udo.u | |----udosh.u | |----udo_hist.u | |----udo_ref.u | |----udo.txt | |----udo_hist.txt | |----udo_ref.txt | |----udosh.txt |----kuerzel | |----everest.krz | |----qed.krz | |----jane.scl |----udosh.app |----udo3.upl |----file_id.diz |----news | |----news.u | |----news.txt C.2 Haftungsausschluž --------------------- Trotz sorgf„ltiger Entwicklung und umfangreichen Tests kann keine Gew„hrleistung fr die Richtigkeit des Inhalts dieser Dokumentation und die einwandfreie Funktion von "UDO" bernommen werden. Dirk Hagedorn Software kann keine Haftung fr irgendwelche direkten oder indirekten Sch„den - einschliežlich aber nicht beschr„nkt auf materielle oder finanzielle - bernehmen, die durch die Benutzung von "UDO" oder dessen Untauglichkeit fr einen bestimmten Zweck entste- hen. C.3 Warenzeichen ---------------- Innerhalb dieser Dokumentation wird auf Warenzeichen Bezug genommen, die nicht explizit als solche ausgewiesen sind. Aus dem Fehlen einer Kennzeichnung kann nicht geschlossen werden, daž ein Name frei von den Rechten Dritter ist.