Home Verschiedenes Abfrage des Betriebssystems Ausgabeformate
 Die Anleitung zu UDO
 Die UDO-Syntax
 Verschiedenes

Formatspezifische Befehle

UDO bietet das !raw-Kommando und die raw-Umgebung an, mit denen es möglich ist, Zeilen nur dann auszugeben, wenn man in ein bestimmtes Format umwandelt.

In diesen Zeilen können dann spezielle Befehle für ein Format angegeben werden, die UDO dann 1:1, also Umwandlung von Sonderzeichen und ohne Einrückungen, ausgibt.

Bei dem !raw-Befehl spielen Kürzel eine große Rolle. Hier eine Übersicht, welches Kürzel für welches Ausgabeformat benutzt werden kann:

amg AmigaGuide
Hypertext-System, vorwiegend zur Dokumentation von Amiga-Programmen
Commodore Amiga
 
aqv Apple QuickView
älteres Hypertext-Format unter Mac OS
Apple
 
asc ASCII
"Plain" Text
alle
 
drc David's Readme Compiler
DOS-Programm zur Erzeugung menügesteuerter ReadMe's als EXE-Datei
MS-DOS
 
hah HTML Apple Help

 
helptag HP-Helptag-SGML
SGML-basiertes Hypertext-Hilfesystem für kommerzielle Unices (HP-UX, Sun Solaris, IBM AIX)
Unix
 
html HTML (Hypertext Markup Language)
Seitenauszeichnungssprache, u.a. für Webseiten, Dokumentationen etc.
plattformunabhängig
 
hh HTMLHelp
zur Erzeugung von HTML-Help-Dateien unter Windows (HTML-Variante mit Erweiterungen)
Win32
 
tex LaTeX 2.09, LaTeX2e
Satzsystem, insbesondere für wissenschaftliche Publikationen
zahlreiche Plattformen
 
ipf OS/2 IPF
SGML-basiertes Textformat zur Erzeugung von Hilfedateien (INF, HLP) unter OS/2
OS/2
 
linuxdoc Linuxdoc-SGML
Linuxdoc-SGML (neuerdings: SGMLtools) ist genau wie UDO ein Multiformat-Konverter, der sein eigenes Format in LaTeX, Manualpage, RTF, HTML, Texinfo etc. umwandeln kann
Unix/Linux
 
lyx LyX
LaTeX-verwandtes Dokumentenverarbeitungsprogramm
Unix/Linux
 
man Manualpage
Unix-/Linux-Hilfeseiten für Kommandozeilenprogramme/-aufrufe
Unix/Linux
 
nroff NROFF
Unix-/Linux-Hilfeseiten für Kommandozeilenprogramme/-aufrufe
Unix/Linux
 
pdflatex PDFLaTeX
zur Erzeugung von PDF-Dateien aus LaTeX
diverse
 
ps PostScript
geräteunabhängige Seitenbeschreibungssprache, z.B. zur Ansteuerung von Druckern; kann zur Erstellung von PDF-Dateien genutzt werden (Ghostscript, Adobe Distiller)
diverse
 
pchelp Pure-C-Help
Hilfesystem für den Pure C-Compiler
Atari ST
 
rtf RTF (Rich Text Format)
Textformat für den Textaustausch zwischen verschiedenen Textverarbeitungsprogrammen
diverse
 
c, pascal Sourcecode (C und Pascal)
Die UDO-Quelldatei wird in Sourcecode umgewandelt, d.h. normaler Text wird Kommentar, der Inhalt der Sourcecode-Umgebung wird C- bzw. Pascal-Source.
diverse
 
stg ST-Guide
Hypertextsystem
Atari ST
 
info GNU Texinfo
zur Erzeugung von Online-Dokumentationen mit dem Kommandozeilen-Aufruf info 'command'
Linux, MiNTNet
 
v Turbo-Vision-Help
zur Erstellung von Onlinehilfen für DOS-Programme, die mit Borlands Turbo Vision-Library geschrieben wurden
MS-DOS
 
udo UDO
führt alle UDO-Eingabedateien in eine einzige zusammen
alle von UDO unterstützten
 
win, wh4 Windows-Help, WinHelp4
RTF-Variante zur Erzeugung von Win-Help-Dateien unter Windows
Windows (Win16, Win32)
 

Um beispielsweise eine Zeile nur in das ASCII-Format auszugeben, gibt man folgendes an:

!raw [asc] Diese Zeile erscheint nur im ASCII-Format

Um eine Zeile in allen Formaten außer dem ASCII-Format auszugeben, gibt man folgendes an:

!ifndest [asc]
!raw [all] Diese Zeile erscheint nicht im ASCII-Format
!endif

Der Inhalt dieser Zeilen wird ohne das Kommando selbst, ohne Berücksichtigung von UDO-Kommandos und ohne Umwandlung von Sonderzeichen ausgegeben. Diese Zeilen sorgen - genau wie alle Kommandos - auch dafür, dass ein Absatz beendet wird. Diese Kommandos eignen sich also nicht dazu, mittem in einem Absatz unterschiedliche Sätze einzufügen!

Dieses Kommandos können dazu dienen, formatspezifische Kommandos einzufügen. Im folgenden Beispiel wird gezeigt, welche Kommandos man in einen Quelltext einfügen muss, damit LaTeX weiß, mit welchem Stil ein Dokument auszudrucken ist und damit es einen Index erzeugt:

!no_preamble [tex]
!raw [tex] \documentstyle[11pt,german,makeidx]{article}
!raw [tex] \makeindex
[...]
!raw [tex] \printindex
Die raw-Umgebung

 
Will man größere Blöcke im jeweiligen Format angeben, wäre es ziemlich mühsam, wenn man jede Zeile mit einem Kürzel beginnen müsste.
 
Daher bietet UDO die "raw-Umgebung" an. Sie wird mit dem Befehl !begin_raw begonnen und mit dem Befehl !end_raw beendet.
 
Genau wie der Inhalt der Zeilen, die mit den obigen Formatkürzeln begonnen werden, gibt UDO diese Zeilen ohne Anpassung von Sonderzeichen und ohne Berücksichtigung von UDO-Befehlen direkt aus.
 
Zusammen mit der Möglichkeit, das Ausgabeformat abzufragen, in das ein Quelltext umgewandelt wird, können spezielle Befehle ausgegeben werden. Anwendungsbeispiele wären z.B. komplizierte Tabellen für LaTeX oder Formulare für HTML. Letzteres soll hier aufgezeigt werden:
 
!ifdest [html]
!begin_raw
<FORM method=post action="mailto:info@dirk-hagedorn.de">
<PRE>
<p>    Name:  <INPUT name="Name" size=60>
<p>
<p>           <INPUT type=submit value="Absenden">
<p>           <INPUT type=reset value="L&ouml;schen">
</PRE>
</FORM>
!end_raw
!else
In der HTML-Version befindet sich hier ein Formular.
!endif

Um noch einmal den Unterschied zur verbatim-Umgebung klarzumachen: Der Text einer verbatim-Umgebung wird 1:1 dargestellt. Würden Sie das obige Formular in eine verbatim-Umgebung packen, würden Sie im HTML-Browser lediglich den Quelltext des Formulars sehen! Nur bei der Verwendung der raw-Umgebung wird das Formular auch als solches vom HTML-Browser dargestellt.
 
Eine weitere Möglichkeit dazu bietet der Befehl !rinclude.
 
Die comment-Umgebung

 
Will man größere Blöcke als Kommentar in die Ausgabedatei schreiben, wäre es ziemlich mühsam, wenn man jede Zeile mit einem Kürzel beginnen müsste.
 
Daher bietet UDO die "comment-Umgebung" an. Sie wird mit dem Befehl !begin_comment begonnen und mit dem Befehl !end_comment beendet.
 
Genau wie der Inhalt der Zeilen, die mit !comment begonnen werden, gibt UDO diese Zeilen ohne Anpassung von Sonderzeichen und ohne Berücksichtigung von UDO-Befehlen als Kommentar aus.
 
Eine weitere Möglichkeit dazu bietet der Befehl !cinclude.
 

Copyright © www.udo-open-source.org
Letzte Aktualisierung am 5. November 2006

Home Verschiedenes Abfrage des Betriebssystems Ausgabeformate