Home Miscellaneous Testing the operating system Output Formats
 The guide of UDO
 The syntax of UDO
 Miscellaneous

Special commands

UDO offers you the !raw command and the raw environment to insert special commands for a specific format. So you are able to insert small passages or huge blocks written in the destination format (like special tables for LaTeX or HTML).

You have to use abbreviations of the destination formates if you want to use the !raw command:

amg AmigaGuide
hypertext system, used for documentation of Amiga programs
Commodore Amiga
 
aqv Apple QuickView
old hypertext format for Mac OS
Apple
 
asc ASCII
"Plain" Text
all
 
drc David's Readme Compiler
DOS program for creating menu-driven ReadMe's as EXE-programs
MS-DOS
 
hah HTML Apple Help

 
helptag HP-Helptag-SGML
SGML-based hypertext helpsystem for commercial Unices (HP-UX, Sun Solaris, IBM AIX)
Unix
 
html HTML (Hypertext Markup Language)
page description language – for websites, documentations and more
platform-independent
 
hh HTMLHelp
HTML-related format, for creation of HTML-Help files under windows
Win32
 
tex LaTeX 2.09, LaTeX2e
typesetting system, especially for scientific publications
many platforms
 
ipf OS/2 IPF
SGML-based text format for creating help files (INF, HLP) under OS/2
OS/2
 
linuxdoc Linuxdoc-SGML
Linuxdoc-SGML (recently: SGMLtools) is – like UDO – a multiformat converter which converts its own format to LaTeX, Manualpage, RTF, HTML, Texinfo...
Unix/Linux
 
lyx LyX
a LaTeX-related document processor
Unix/Linux
 
man Manualpage
Unix-/Linux-help pages for commandline programs
Unix/Linux
 
nroff NROFF
Unix-/Linux-help pages for commandline programs
Unix/Linux
 
pdflatex PDFLaTeX
for producing PDF files from LaTeX
diverse
 
ps PostScript
device-independent page description language, e.g. for printers; can also be used for producing PDF files (Ghostscript, Adobe Distiller)
several
 
pchelp Pure-C-Help
help system for the Pure C compiler
Atari ST
 
rtf RTF (Rich Text Format)
for exchanging text between different programs and platforms
several
 
c, pascal Sourcecode (C und Pascal)
the UDO source file will be converted to sourcecode, meaning normal text becomes comment, the content of the sourcecode environment becomes C-/Pascal-sourcecode.
several
 
stg ST-Guide
a hypertext system
Atari ST
 
info GNU Texinfo
for making online documentations, started with info 'command'
Linux, MiNTNet
 
v Turbo-Vision-Help
creating online helpfiles for DOS programs written with Borland's Turbo Vision-Library
MS-DOS
 
udo UDO
merges all UDO input files into one big file
all platforms with UDO-support
 
win, wh4 Windows-Help, WinHelp4
RTF-derived format for producing WinHelp files under Windows
Windows (Win16, Win32)
 

The next example shows how to insert a line that will only be printed for the ASCII format:

!raw [asc] This line will only appear when converting to ASCII

The next example shows how to insert a line that appears in all formats except ASCII:

!ifndest [asc]
!raw [all] This line will not appear when convertign to ASCII
!endif

The contents of the line will be printed without the command and without converting the text of the line. These commands split up text into different paragraphs like all the other UDO commands. So these commands aren't useful to insert a line into a paragraph!

You can use these commands to insert special commands like parts of the preamble for LaTeX:

!no_preamble [tex]
!raw [tex] \documentstyle[11pt,makeidx]{article}
!raw [tex] \makeindex
[...]
!raw [tex] \printindex
The raw environment

 
But it happens that you want to insert large passages only for one format with special commands. You could add one of the upper commands at the beginning of each line, sure. But to make it easier for you to insert these passages UDO has a special environment for this case: the raw environment.
 
Together with the possibility to check the current destination format you can e.g. insert complex tables for LaTeX or forms for HTML with the raw environment. The following example shows how to enter HTML forms to your source code:
 
!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="Send">
<p>           <INPUT type=reset value="Reset">
</PRE>
</FORM>
!end_raw
!else
The HTML version will display a form here.
!endif

To say it once more: Text that is part of a raw environment is printed "as is". That means that it's not converted and not indented. If you will insert the upper form source code into a verbatim environment you will see the source code in an HTML browser. But if you insert it inside a raw environment you will see the form!
 
Another choice you have is to use the command !rinclude.
 
The comment environment

 
If you want to write larger blocks in the output file as comments, it would be troublesome to start each line with a command.
 
Therefore UDO offers the "comment environment". It will be started with the command !begin_comment and ends with the command !end_comment.
 
As with the text of lines that start with the !comment command, UDO will write text inside this environment as comment to the destination file without converting special chars.
 
Another choice you have is to use the command !cinclude.
 

Copyright © www.udo-open-source.org
Last updated on November 5, 2006

Home Miscellaneous Testing the operating system Output Formats