Home Command index H... L...

I...


!if

Type & position: command, preamble & main part
 
Syntax: !if [<text>]
 
Description: This command combines the commands !ifdest, !iflang, !ifset and !ifos. The example shows how to test if the source file is converted into an English HTML file.
 
Example: !if [english,html]
 
See: !iflang, !ifdest, !ifset, !ifos, Query commands
 

!ifdest

Type & position: command, preamble & main part
 
Syntax: !ifdest [<abbreviations>]
 
Description: This command tests the current destination format. If one of the "<abbreviations>" matches the abbreviation of the destination format UDO will convert all lines between !ifdest and !else or !endif. If not UDO will only convert the lines between !else and !endif if !else is used. The example shows how to test if UDO converts to ST-Guide or Windows Help.
 
Example: !ifdest [stg,win]
 
See: !else, !endif, !ifndest, !if, Query commands
 

!iflang

Type & position: command, preamble & main part
 
Syntax: !iflang [<languages>]
 
Description: This command test the language UDO uses for the destination file. If "<language>" matches one of the abbreviations for the destination languages UDO will convert all lines between !iflang and !else or !endif. If not UDO will only convert the lines between !else and !endif if !else is used. The example shows how to test if UDO converts to English.
 
Example: !iflang [english]
 
See: !ifnlang, !ifdest, !language, Query commands
 

!ifndest

Type & position: command, preamble & main part
 
Syntax: !ifndest [<abbreviation>]
 
Description: This command tests the current destination format. If none of the "<abbreviations>" match the abbreviation of the destination format UDO will convert all lines between !ifdest and !else or !endif. If one matches them UDO will only convert the lines between !else and !endif if !else is used. The example shows how to test if UDO doesn't convert to HTML.
 
Example: !ifndest [html]
 
See: !else, !endif, !ifdest, Query commands
 

!ifnlang

Type & position: command, preamble & main part
 
Syntax: !ifnlang [<languages>]
 
Description: This command tests the current destination language. If none of the "<languages>" match the abbreviation of the destination language UDO will convert all lines between !ifdest and !else or !endif. If one matches them UDO will only convert the lines between !else and !endif if !else is used. The example shows how to test if UDO doesn't convert to French.
 
Example: !ifnlang [french]
 
See: !ifnlang, !ifdest, !language, Query commands
 

!ifnos

Type & position: command, preamble & main part
 
Syntax: !ifnos [<systems>]
 
Description: This command tests the current operating system UDO is running on. If "<systems>" doesn't match any of the abbreviations of the operating systems UDO will convert all lines that follow !else if it is used. If !else isn't used UDO will ignore all lines until an !endif. The example shows how you can test if UDO !doesn't run on an Apple Macintosh.
 
Example: !ifnos [macos]
 
See: !ifos
 

!ifnset

Type & position: command, preamble & main part
 
Syntax: !ifnset [<text>]
 
Description: With this command you can test if a symbol !wasn't set with the command line option -D or with !set. If <text> wasn't set UDO will convert all lines bewteen !ifnset and !else or !endif. If <text> was set UDO will convert all lines between !else and !endif if !else was used. The example shows how to test if the symbol "british" isn't set.
 
Example: !ifnset [british]
 
See: !ifset
 

!ifos

Type & position: command, preamble & main part
 
Syntax: !ifos [<text>]
 
Description: This command tests the current operating system UDO is running on. If "<systems>" match one of the abbreviations of the operating systems UDO will convert all lines that are used between !ifos and !endif or !else. If "<systems>" doesn't match any of the abbreviations of the operating systems UDO will ignore all lines before !endif or !else. The example shows how you can test if UDO runs with Linux.
 
Example: !ifos [linux]
 
See: !ifnos
 

!ifset

Type & position: command, preamble & main part
 
Syntax: !ifset [<text>]
 
Description: With this command you can test if a symbol was set with the command line option -D or with !set. If <text> was set UDO will convert all lines bewteen !ifset and !else or !endif. If <text> wasn't set UDO will convert all lines between !else and !endif if !else was used. The example shows how to test if the symbol "british" was set.
 
Example: !ifset [british]
 
See: !ifnset
 

!ignore_bottomline

Type & position: switch, preamble
 
Syntax: !ignore_bottomline
 
Description: If this switch is used inside a chapter UDO won't print a headline. In contrast to !no_bottomlines this switch will only suppress the headline inside the chapter where !ignore_bottomline is used.
 
See: !no_bottomlines
 

!ignore_headline

Type & position: switch, preamble
 
Syntax: !ignore_headline
 
Description: If this switch is used inside a chapter UDO won't print a headline. In contrast to !no_headlines this switch will only suppress the headline inside the chapter where !ignore_headline is used.
 
See: !no_headlines
 

!ignore_index

Type & position: switch, main part
 
Syntax: !ignore_index
 
Description: If this switch is used inside a chapter UDO won't add its title to the index even if the switch !use_nodes_inside_index is used inside the preamble of the source file.
 
See: !use_nodes_inside_index, !no_index, Indices
 

!ignore_links

Type & position: switch, main part
 
Syntax: !ignore_links
 
Description: If this switch is part of a chapter UDO won't insert links to this chapter automatically. You are still able to insert links with !link ...) on your own.
 
See: Links, (!link ...)
 

!ignore_subsubsubtoc

Type & position: switch, main part
 
Syntax: !ignore_subsubsubtoc
 
Description: If this switch is used inside a subsection UDO won't print a "subsubsubtoc" which contains all paragraphs of this subsection even if you have used !use_auto_subsubsubtocs inside the preamble.
 
See: !use_auto_subsubsubtocs, !subsubsubtoc
 

!ignore_subsubtoc

Type & position: switch, main part
 
Syntax: !ignore_subsubtoc
 
Description: If this switch is used inside a section UDO won't print a "subsubtoc" which contains all subsections and paragraphs of this section even if you have used !use_auto_subsubtocs inside the preamble.
 
See: !use_auto_subsubtocs, !subsubtoc
 

!ignore_subtoc

Type & position: switch, main part
 
Syntax: !ignore_subtoc
 
Description: If this switch is used inside a chapter UDO won't print a "subtoc" which contains all sections, subsections and paragraphs of this chapter even if you have used !use_auto_subtocs inside the preamble.
 
See: !use_auto_subtocs, !subtoc
 

!image

Type & position: command, main part
 
Syntax: !image <file> <caption>
 
Description: A command to include an image is generated in the destination file, if it supports images. You shouldn't pass the suffix of the wanted image because UDO itself adds the right one. It will be .img for the ST-Guide, CSTeX and Lindner-TeX, .gif for HTML, .msp or .pcx for emTeX and .bmp for Windows Help. If `<caption>' is used it will be printed as the title of this image. The position of this image depends of the outer environment if used. To print a centred image you have to use the !image command inside a center-environment.
 
Example: !image tiger
 
See: !no_images, (!image ...), Images, !html_img_suffix
 

!image*

Type & position: command, main part
 
Syntax: !image* <file> <caption>
 
Description: There's one difference between !image* and !image. If you use this command there will be printed no table number.
 
Example: !image* tiger This is a tiger
 
See: !image
 

!image_counter

Type & position: switch, preamble
 
Syntax: !image_counter [<value>]
 
Description: With this switch you can set the image counter. If you use the lower example the caption of the first image will look like this: "Figure 5: ...".
 
Example: !image_counter 5
 
See: Images
 

!include

Type & position: command, preamble & main part
 
Syntax: !include <file>
 
Description: Opens the file named "file" and converts its contents.
 
Example: !include macros.ui
 
See: !vinclude, !rinclude, Split documents
 

!index

Type & position: command, main part
 
Syntax: !index <text>
 
Description: <text> will pe printed as \index {...} for LaTeX, K{\footnote K ...} for WinHelp, {\xe\v ...} for RTF and @index ... for ST-Guide. So, <text> appears in the index of LaTeX and ST-Guide. WinHelp allows to search this word. You can use this command as many times as you like.
 
Example: !index entry !! index
 
See: Indices, !no_index
 

!item

Type & position: command, main part
 
Syntax: !item <text>
 
Description: Starts a new item of an itemize or enumerate environment.
 
Example: !item This is the next item
 
See: !item [ ], Itemizations, Enumerations
 

!item [ ]

Type & position: command, main part
 
Syntax: !item [<text>]
 
Description: Starts a new item of a description or an xlist environment. "<text>" will be displayed in bold text inside a description environment.
 
Example: !item [Title:] Description
 
See: !item, Descriptions, Lists
 

(!I)...(!i)

Type & position: placeholder, preamble & main part
 
Syntax: (!I)<text>(!i)
 
Description: "<text>" will be displayed in italics if possible.
 
Example: (!I)italic(!i)
 
See: Emphasizing text
 

(!idx ...)

Type & position: placeholder, main part
 
Syntax: (!idx [<text>] {[<index1>]} {[<index2>]} {[<index3>]} )
 
Description: Useful for adding indices right inside the source file.
 
Example: (!idx [word] [index entry])
 
See: Indices, !no_index, !index
 

(!ilink ...)

Type & position: placeholder, main part
 
Syntax: (!ilink [<file>] [<text>] [<link>])
 
Description: This placeholder is a combination of (!img ...) and (!link ...) and is useful to display an image right inside the text. If you click this image you will jump to another part of the document. The example shows how to display an image called disk.[bmp,gif], the link destination is "Download". In HTML "download UDO" will be used as the alternative text. In all other formats only "download" UDO will be dislayed.
 
Example: (!ilink [disk] [download UDO] [Download]
 
See: (!img~..), (!link ...), Links, Images
 

(!img ...)

Type & position: placeholder, main part
 
Syntax: (!img [<file>] [<text>])
 
Description: Use this placeholder to use an image right inside the text of HTML or WinHelp. If another destination format will be used only "<text>" will be displayed. When converting to HTML file.gif will be used, when converting to WinHelp file.bmp will be used. UDO doesn't check if this file exists.
 
Example: (!img [dh] [my logotype])
 
See: Images, !image
 

Home Command index H... L...