/usr/share/doc/udo-doc-en/html/005007.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
        "http://www.w3.org/TR/html4/loose.dtd">
<!-- last modified on 2005/10/25 -->
<html lang="en">
<head>
<title>
The guide to UDO: Images
</title>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<meta http-equiv="Content-Language" content="en">
<meta http-equiv="Content-Style-Type" content="text/css">
<meta http-equiv="Content-Script-Type" content="text/javascript">
<meta name="Generator" content="UDO 6.4 PL1 for Linux">
<meta name="Author" content="Dirk Hagedorn">
<link rel="chapter" href="001.html" title="Introduction">
<link rel="chapter" href="opensrc.html" title="Open Source">
<link rel="chapter" href="003.html" title="Installation">
<link rel="chapter" href="004.html" title="Usage">
<link rel="chapter" href="005.html" title="The syntax of UDO">
<link rel="chapter" href="006.html" title="Tips &amp; tricks">
<link rel="section" href="005001.html" title="A short example">
<link rel="section" href="005002.html" title="Basics">
<link rel="section" href="005003.html" title="Structuring">
<link rel="section" href="005004.html" title="Emphasising text">
<link rel="section" href="005005.html" title="Special characters">
<link rel="section" href="005006.html" title="Syllabification">
<link rel="section" href="005008.html" title="Hypertext commands">
<link rel="section" href="005009.html" title="Miscellaneous">
<link rel="appendix" href="_a.html" title="Frequently asked questions">
<link rel="appendix" href="_b.html" title="Bugs">
<link rel="appendix" href="_c.html" title="Error messages">
<link rel="appendix" href="_d.html" title="This &amp; that">
<link rel="appendix" href="_e.html" title="History">
<link rel="appendix" href="_f.html" title="Command index">
<link rel="start" href="index.html" title="Begin of the document">
<link rel="home" href="index.html" title="Begin of the document">
<link rel="contents" href="index.html#UDOTOC" title="Contents">
<link rel="toc" href="index.html#UDOTOC" title="Contents">
<link rel="first" href="001.html" title="Introduction">
<link rel="prev" href="005006.html" title="Syllabification">
<link rel="previous" href="005006.html" title="Syllabification">
<link rel="next" href="005008.html" title="Hypertext commands">
<link rel="last" href="_f016.html" title="---">
<link rel="copyright" href="aboutudo.html" title="UDO6">
</head>
<body>

<a href="index.html"><img src="udo_hm.gif" alt="Home" border="0" width="24" height="24"></a>
<a href="005.html"><img src="udo_up.gif" alt="The syntax of UDO" border="0" width="24" height="24"></a>
<a href="005006.html"><img src="udo_lf.gif" alt="Syllabification" border="0" width="24" height="24"></a>
<a href="005008.html"><img src="udo_rg.gif" alt="Hypertext commands" border="0" width="24" height="24"></a>
<hr>
<h1><a name="Images">Images</a></h1>
<p>UDO enables you to include images into your destination format if
it supports images like ST-Guide, LaTeX, HTML and Windows Help. This
chapter explains how to include images into a destination file and
what destination commands UDO generates.
</p>
<p>To display an image you can use the <i><a href="_f00a.html#UDO__21image">!image</a></i> command. You
have to add the name of the image <i>without</i> suffix and an
optional image title.
</p>
<p>To display images right inside the text you can use the
placeholder <i>(!img ..)</i> when converting into Windows Help or
HTML. The other formats don't allow to use images inside the text or
it is so difficult that UDO can't automatize it.
</p>
<p>Since Release 6 images will not be centred in all cases. To
display a centred image you have to insert the <i><a href="_f00a.html#UDO__21image">!image</a></i> command
into a <a href="005004.html#center_20environment">center environment</a>. To display a right justified image you have
to insert the <i><a href="_f00a.html#UDO__21image">!image</a></i> command inside a <a href="005004.html#flushright_20environment">flushright environment</a>.
In all other cases images will be displayed left justified.
</p>
<ul class="content">
<li><a href="#UDO__2A.img_20_26amp_3B_20ST-Guide">*.img &amp; ST-Guide</a></li>
<li><a href="#UDO__2A.img_20_26amp_3B_20Lindner-TeX">*.img &amp; Lindner-TeX</a></li>
<li><a href="#UDO__2A.img_20_26amp_3B_20CS-TeX_2FMultiTeX">*.img &amp; CS-TeX/MultiTeX</a></li>
<li><a href="#UDO__2A.msp_20_26amp_3B_20emTeX">*.msp &amp; emTeX</a></li>
<li><a href="#UDO__2A.pcx_20_26amp_3B_20emTeX">*.pcx &amp; emTeX</a></li>
<li><a href="#UDO__2A.gif_20_26amp_3B_20HTML">*.gif &amp; HTML</a></li>
<li><a href="#UDO__2A.jpg_20_26amp_3B_20HTML">*.jpg &amp; HTML</a></li>
<li><a href="#UDO__2A.bmp_20_26amp_3B_20WinHelp">*.bmp &amp; WinHelp</a></li>
</ul>
<br>
<h3><a name="UDO__2A.img_20_26amp_3B_20ST-Guide">*.img &amp; ST-Guide</a></h3>
<p>Example: <tt><a href="_f00a.html#UDO__21image">!image</a> tiger A tiger</tt>
</p>
<p>UDO opens the file <tt>tiger.img</tt> and reads the size of this
image. A special ST-Guide command called <tt>@limage</tt> is generated
and the needed parameters are calculated due to the information of the
GEM image header.
</p>
<p>If you want to display a subtitle add it right after the name of
the image file. This subtitle will look like &quot;(Figure x: A
tiger)&quot;.
</p>
<h3><a name="UDO__2A.img_20_26amp_3B_20Lindner-TeX">*.img &amp; Lindner-TeX</a></h3>
<p>If you are using Lindner-TeX and you want to include a GEM image
into your DVI file you have to add <i><a href="_f011.html#UDO__21tex_lindner">!tex_lindner</a></i> to your
preamble.
</p>
<p>UDO replaces the tool called <tt>IMGTOTEX</tt> that is part of
Lindner-TeX. UDO has all functions of this tool built in.
</p>
<p>To set the size of an image you have to use the <i><a href="_f011.html#UDO__21tex_dpi">!tex_dpi</a></i>
command. An example:
</p>
<blockquote>
<pre><a href="_f011.html#UDO__21tex_dpi">!tex_dpi</a> 100
<a href="_f00a.html#UDO__21image">!image</a> tiger A GEM image
</pre>
</blockquote>
<p>UDO reads in the header of <tt>tiger.img</tt>, calculates its size
and adjusts the header to 100 dpi. In the destination file a TeX macro
will be generated that includes this image and displays it with 100
dpi.
</p>
<br>
<p><b>Please note:</b> Using 100 dpi screenshots are displayed in
the original screen size on my HP DeskJet 510. <i><a href="_f011.html#UDO__21tex_dpi">!tex_dpi</a></i> can
be used before any image. If you are using an image more than once you
shouldn't try to display it in different resolutions. Use a copy of
your image instead and display the original one with the first and the
copy with the second resolution.
</p>
<h3><a name="UDO__2A.img_20_26amp_3B_20CS-TeX_2FMultiTeX">*.img &amp; CS-TeX/MultiTeX</a></h3>
<p>If you are using CS-TeX or MultiTeX and you want to include a GEM
image into your DVI file you have to add <i><a href="_f011.html#UDO__21tex_strunk">!tex_strunk</a></i> to your
preamble.
</p>
<p>Because the drivers of CS-TeX support the macros of Lindner-TeX
the same is done here as in the upper section.
</p>
<h3><a name="UDO__2A.msp_20_26amp_3B_20emTeX">*.msp &amp; emTeX</a></h3>
<p>If you are using emTeX and you want to include an MSP image to
your DVI file you have to add <i><a href="_f011.html#UDO__21tex_emtex">!tex_emtex</a></i> to your preamble.
Furthermore you have to set the resolution of an image via
<i><a href="_f011.html#UDO__21tex_dpi">!tex_dpi</a></i>.
</p>
<p>The macros for emTeX are generated according to the information of
<tt>dvidrv.doc</tt> of emTeX.
</p>
<p>In first place UDO tries to read in the header of
<tt>tiger.msp</tt> when reading the command <tt><a href="_f00a.html#UDO__21image">!image</a> tiger A
tiger</tt>. If UDO doesn't find <tt>tiger.msp</tt> it will try to find
<tt>tiger.pcx</tt>.
</p>
<p>An example shows what kind of macro UDO generates for emTeX. `w'
and `h' represent the width and height of the image:
</p>
<blockquote>
<pre>\begin{figure}[htb]
\begin{...}
\begin{picture}(&lt;w&gt;,&lt;h&gt;)
    \put(0,&lt;h&gt;){\special{em:graph tiger.msp}}
\end{picture}
\end{...}
\caption{A tiger}
\end{figure}
</pre>
</blockquote>
<p><b>Please note:</b> I use <i><a href="_f011.html#UDO__21tex_dpi">!tex_dpi</a> 300</i> on my HP DeskJet
510 to display screenshots.
</p>
<h3><a name="UDO__2A.pcx_20_26amp_3B_20emTeX">*.pcx &amp; emTeX</a></h3>
<p>If you are using emTeX and you want to include a Paintbrush PCX to
your DVI file you have to add <i><a href="_f011.html#UDO__21tex_emtex">!tex_emtex</a></i> to your preamble.
Furthermore you have to set the resolution of an image via
<i><a href="_f011.html#UDO__21tex_dpi">!tex_dpi</a></i>.
</p>
<p>The macros for emTeX are generated according to the information of
<tt>dvidrv.doc</tt> of emTeX.
</p>
<p>In first place UDO tries to read in the header of
<tt>tiger.msp</tt> when reading the command <tt><a href="_f00a.html#UDO__21image">!image</a> tiger A
tiger</tt>. If UDO doesn't find <tt>tiger.msp</tt> it will try to find
<tt>tiger.pcx</tt>.
</p>
<p>An example shows what kind of macro UDO generates for emTeX. `w'
and `h' represent the width and height of the image:
</p>
<blockquote>
<pre>\begin{figure}[htb]
\begin{...}
\begin{picture}(&lt;w&gt;,&lt;h&gt;)
    \put(0,&lt;h&gt;){\special{em:graph tiger.pcx}}
\end{picture}
\end{...}
\caption{A tiger}
\end{figure}
</pre>
</blockquote>
<br>
<p><b>Note:</b> In first place UDO tries to find an MSP image. If
you are using images from Paintbrush PCX you can ignore the warning
printed by UDO.
</p>
<h3><a name="UDO__2A.gif_20_26amp_3B_20HTML">*.gif &amp; HTML</a></h3>
<p>UDO can generate HTML commands to include a GIF. UDO doesn't check
if the GIF is existing!
</p>
<p>For HTML the second parameter of the <i><a href="_f00a.html#UDO__21image">!image</a></i> command will
be used as the alternative text. The command <tt><a href="_f00a.html#UDO__21image">!image</a> tiger A
tiger</tt> will be converted into the following HTML commands:
</p>
<blockquote>
<pre>&lt;p align=...&gt;
&lt;img src=&quot;tiger.gif&quot; alt=&quot;(Figure 1: A tiger)&quot;&gt;
&lt;/p&gt;&lt;br&gt;
</pre>
</blockquote>
<p>If you don't set the title of this image UDO doesn't output an
alternative text. The command <tt><a href="_f00a.html#UDO__21image">!image</a> tiger</tt> will be converted
into this:
</p>
<blockquote>
<pre>&lt;p align=...&gt;
&lt;img src=&quot;../gif/tiger.gif&quot; alt=""&gt;
&lt;/p&gt;&lt;br&gt;
</pre>
</blockquote>
<h3><a name="UDO__2A.jpg_20_26amp_3B_20HTML">*.jpg &amp; HTML</a></h3>
<p>By default UDO expects that you want to display GIF's (see above).
But it's possible to display any other kind of image format, too.
</p>
<p>To tell UDO which suffix you want to use the next time you use the
<i><a href="_f00a.html#UDO__21image">!image</a></i> command you can use the command
<i><a href="_f009.html#UDO__21html_img_suffix">!html_img_suffix</a></i>.
</p>
<p>If the upper tiger isn't inside a GIF but inside a JPEG image you
can insert the following command right before the <i><a href="_f00a.html#UDO__21image">!image</a></i>
command:
</p>
<blockquote>
<pre><a href="_f009.html#UDO__21html_img_suffix">!html_img_suffix</a> jpg
</pre>
</blockquote>
<p>If the file is named <tt>tiger.jpeg</tt> instead of
<tt>tiger.jpg</tt> use the following line:
</p>
<blockquote>
<pre><a href="_f009.html#UDO__21html_img_suffix">!html_img_suffix</a> jpeg
</pre>
</blockquote>
<p>The setting is used for all following images. If you want to
display a GIF next time you have to use <i><a href="_f009.html#UDO__21html_img_suffix">!html_img_suffix</a>&nbsp;gif</i>
before the next <i><a href="_f00a.html#UDO__21image">!image</a></i> command is used.
</p>
<h3><a name="UDO__2A.bmp_20_26amp_3B_20WinHelp">*.bmp &amp; WinHelp</a></h3>
<p>UDO can generate commands for Windows Help to display Windows
bitmaps (BMP). UDO doesn't check if a BMP is existing!
</p>
<p>An image can be displayed with or without a subtitle. Windows Help
centers the image in the help file.
</p>
<ol>
<li> without subtitle: <tt><a href="_f00a.html#UDO__21image">!image</a> tiger</tt>
<br>&nbsp;
</li>
<li> with subtitle: <tt><a href="_f00a.html#UDO__21image">!image</a> tiger A tiger</tt>
<br>&nbsp;
</li>
</ol>
<p>UDO will then generate these commands:
</p>
<blockquote>
<pre>{\qc \{bmc tiger.bmp\}}\par\pard
\par
{\qc (Figure 1: A tiger)}\par\pard
</pre>
</blockquote>
<p><b>Please note:</b>
</p>
<ol>
<li> UDO won't check if the image file is existing. If it doesn't
exists or the filename is wrong the Microsoft Helpcompiler will print
an error message.
<br>&nbsp;
</li>
<li> With the switch <i><a href="_f014.html#UDO__21win_inline_bitmaps">!win_inline_bitmaps</a></i> you can tell UDO to
use special Windows Help commands to use &quot;hard-coded&quot;
images.
<br>&nbsp;
</li>
</ol>
<hr>
<a href="index.html"><img src="udo_hm.gif" alt="Home" border="0" width="24" height="24"></a>
<a href="005.html"><img src="udo_up.gif" alt="The syntax of UDO" border="0" width="24" height="24"></a>
<a href="005006.html"><img src="udo_lf.gif" alt="Syllabification" border="0" width="24" height="24"></a>
<a href="005008.html"><img src="udo_rg.gif" alt="Hypertext commands" border="0" width="24" height="24"></a>
</body></html>
udo-doc-en 6.4.1-1 / usr / share / doc / udo-doc-en / html / 005007.html
