Home Query commands Query commands Testing the destination language
 The guide of UDO
 The syntax of UDO
 Miscellaneous
 Query commands

Testing the destination format

With the command !ifdest you can test the destination format. Use the following abbreviations:

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)
 

In addition to these abbreviations you can use "all" and "none". A query with "all" always returns a true value, a query with "none" always returns a false value.

The following example shows how to set a special document title for Windows Help:

!ifdest [win]
!docinfo [title] The Windows Help to
!else
!docinfo [title] The guide to
!endif

The !ifndest command is related to !ifdest. But !ifndest will check if you do not convert to the given destination format. Thus you can write the upper example this way, too:

!ifndest [win]
!docinfo [title] The guide to
!else
!docinfo [title] The Windows Help to
!endif

You can pass more than one abbreviation to the query command. If you do so the query returns a true value if one or more abbreviations match the current destination format. The next example shows how to set a special document title for hypertext formats:

!ifdest [win,html,stg,htag]
!docinfo [title] The hypertext to
!else
!docinfo [title] The guide to
!endif

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

Home Query commands Query commands Testing the destination language