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

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
        "http://www.w3.org/TR/html4/loose.dtd">
<!-- last modified on 2005/08/09 -->
<html lang="en">
<head>
<title>
The guide to UDO: Hypertext commands
</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="005007.html" title="Images">
<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="005007.html" title="Images">
<link rel="previous" href="005007.html" title="Images">
<link rel="next" href="005009.html" title="Miscellaneous">
<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="005007.html"><img src="udo_lf.gif" alt="Images" border="0" width="24" height="24"></a>
<a href="005009.html"><img src="udo_rg.gif" alt="Miscellaneous" border="0" width="24" height="24"></a>
<hr>
<h1><a name="Hypertext_20commands">Hypertext commands</a></h1>
<ul class="content">
<li><a href="#Labels">Labels</a></li>
<li><a href="#Links">Links</a></li>
<ul class="content">
<li><a href="#Internal_20links">Internal links</a></li>
<li><a href="#Internal_20links_20with_20images">Internal links with images</a></li>
<li><a href="#Internal_20links_20to_20pages">Internal links to pages</a></li>
<li><a href="#External_20links">External links</a></li>
</ul>
</ul>
<br>
<h3><a name="Labels">Labels</a></h3>
<p>Using the command <i><a href="_f00b.html#UDO__21label">!label</a></i> you can set labels inside the
source file. An example:
</p>
<blockquote>
<pre><a href="_f00b.html#UDO__21label">!label</a> example
</pre>
</blockquote>
<p>When converting to the hypertext formats Windows Help, HTML,
ST-Guide and Pure C Help UDO inserts references inside the text to
this label automatically. You can search for these labels inside the
search dialog of Windows Help.
</p>
<p>When you set the upper label you can jump from every position
where the word &quot;example&quot; is used to the position where you
used the label.
</p>
<p>Here a list how UDO converts a label for the hypertext formats:
</p>
<table>
<tr><td nowrap valign="top">HTML:</td><td valign="top"> <tt>&lt;a name=&quot;example&quot;&lt;/a&gt;</tt>
</td></tr>
<tr><td nowrap valign="top">LaTeX:</td><td valign="top"> <tt>\label{example}</tt>
</td></tr>
<tr><td nowrap valign="top">Linuxdoc-SGML:</td><td valign="top"> <tt>&lt;label id=&quot;example&quot;&gt;</tt>
</td></tr>
<tr><td nowrap valign="top">Pure-C-Help:</td><td valign="top"> <tt>sensitive(&quot;example&quot;)</tt> inside the header
</td></tr>
<tr><td nowrap valign="top">ST-Guide:</td><td valign="top"> <tt>@symbol ar example</tt>
</td></tr>
<tr><td nowrap valign="top">Turbo-Vision:</td><td valign="top"> <tt>.topic example</tt> inside the header
</td></tr>
<tr><td nowrap valign="top">WinHelp:</td><td valign="top"> <tt>#{\footnote # example}</tt>
</td></tr></table>
<br>
<p><b>Please note:</b> You shouldn't use special chars like commas,
semicolons, quotes or apostrophes inside the label text because some
formats have problems with these special characters. Please try to
avoid them. In most cases you can avoid them if you really want.
</p>
<h3><a name="Links">Links</a></h3>
<p>Sometimes you maybe want to set a link to other parts of the
current document or to other documents. To make it possible for you to
insert links UDO offers you the placeholders called
<i>(!link...)</i>, <i>(!xlink...)</i> and <i>(!plink...)</i>.
</p>
<p><b>Please note:</b> If you want to use a &quot;(&quot; or a
&quot;]&quot; inside a link you have to quote it with an exclamation
mark:
</p>
<blockquote>
<pre>Wrong: (!link [Brackets])] [Link])
Right: (!link [Brackets!]!)] [Link])
                       <a href="_f016.html#UDO_---">---</a>-
</pre>
</blockquote>
<ul class="content">
<li><a href="#Internal_20links">Internal links</a></li>
<li><a href="#Internal_20links_20with_20images">Internal links with images</a></li>
<li><a href="#Internal_20links_20to_20pages">Internal links to pages</a></li>
<li><a href="#External_20links">External links</a></li>
</ul>
<br>
<h4><a name="Internal_20links">Internal links</a></h4>
<p>Using the <i>(!link...)</i> command you can insert links to
parts of the current document. You can link to chapters, sections,
subsections, labels and aliases. The following list shows you how to
use the link command and how UDO converts it:
</p>
<blockquote>
<pre>UDO:       (!link [a word] [the link])
HTML:      &lt;a href=&quot;file.htm#the link&quot;&gt;a word&lt;/a&gt;
LaTeX:     a word (see \ref{the link})
ST-Guide:  @{&quot;a word&quot; link &quot;the link&quot;}
WinHelp:   {\uldb a word}{\v the_link}
Turbo:     {a word:the_link}
else:      a word (see &quot;the link&quot;)
</pre>
</blockquote>
<p>The following example shows how to insert a link to my contact
addresses:
</p>
<blockquote>
<pre>If you want to register UDO,
please send (!link [me] [<a href="001005.html">Contact addresses</a>])
an email.
</pre>
</blockquote>
<p>... will be displayed this way:
</p>
<p>If you want to register UDO, please send <a href="001005.html">me</a> an email.
</p>
<p><b>Please note:</b>
</p>
<ol>
<li> You may use up to (!MAXLINKS) inside a paragraph. If you will use
more links UDO will print an error message.
<br>&nbsp;
</li>
<li> When converting to hypertext formats UDO checks if the link
destination exists. If it doesn't exits UDO prints an error message.
When converting to the other formats UDO doesn't check if the link
destination exists!
<br>&nbsp;
</li>
<li> LaTeX only allows it to link to aliases and labels.
<br>&nbsp;
</li>
</ol>
<h4><a name="Internal_20links_20with_20images">Internal links with images</a></h4>
<p>Especially for Windows Help and HTML there's existing the
<i>(!ilink...)</i> (&quot;image link&quot;) commands. It is a
mixture of the <i>(!img...)</i> and <i>(!link...)</i> command that
allows to display &quot;hyperimages&quot;. If you click an image you
will jump to another part of the current document.
</p>
<blockquote>
<pre>UDO:      (!ilink [img] [text] [link])
WinHelp:  {\uldb \{bmc img.bmp\}}{\v link}
HTML:     &lt;a href=&quot;link&quot;&gt;&lt;img src=&quot;img.gif&quot; alt=&quot;text&quot;&gt;&lt;/a&gt;
else:     like (!link [text] [link])
</pre>
</blockquote>
<p><b>Please note:</b>
</p>
<ol>
<li> UDO won't check if the images exist.
<br>&nbsp;
</li>
<li> By default UDO uses `<tt>.gif</tt>' as the suffix for images when
converting to HTML. You can use the command <i><a href="_f009.html#UDO__21html_img_suffix">!html_img_suffix</a></i>
to change the suffix.
<br>&nbsp;
</li>
<li> You may use up to (!MAXLINKS) inside a paragraph. If you will use
more links UDO will print an error message.
<br>&nbsp;
</li>
</ol>
<h4><a name="Internal_20links_20to_20pages">Internal links to pages</a></h4>
<p>Especially for LaTeX there's existing the <i>(!plink...)</i>
(&quot;page link&quot;) command:
</p>
<blockquote>
<pre>UDO:    (!plink [link commands] [<a href="#Links">Links</a>])
LaTeX:  link commands (see page \pageref{<a href="#Links">Links</a>})
else:   link commands
</pre>
</blockquote>
<p>The following example shows how to insert a page like to the page
that contains my contact addresses:
</p>
<blockquote>
<pre>If you want to register UDO,
please send (!plink [me] [<a href="001005.html">Contact addresses</a>])
an email.
</pre>
</blockquote>
<p>... will be displayed this way:
</p>
<p>If you want to register UDO, please send me an email.
</p>
<p><b>Please note:</b>
</p>
<ol>
<li> You can only insert page links to labels and aliases, not to
chapters when converting to LaTeX.
<br>&nbsp;
</li>
<li> You may use up to (!MAXLINKS) inside a paragraph. If you will use
more links UDO will print an error message.
<br>&nbsp;
</li>
</ol>
<h4><a name="External_20links">External links</a></h4>
<p>With the <i>(!xlink...)</i> (&quot;external link&quot;) command
you can insert links to (parts of) other documents, net sites or
hypertexts. The difference to the upper command: UDO doesn't adjust
special chars of the link destination. The tilde isn't a non-breaking
space in the link destination, too.
</p>
<blockquote>
<pre>UDO:       (!xlink [UDO] [*:\udo.hyp])
ST-Guide:  @{&quot;UDO&quot; link &quot;*:\udo.hyp&quot;}

UDO:       (!xlink [Atari] [http://www.atari.com])
HTML:      &lt;A HREF=&quot;http://www.atari.com&quot;&gt;Atari&lt;/A&gt;

UDO:       (!xlink [UDO] [Titel@d:/winhelp/udo.hlp])
WinHelp:   {\uldb UDO}{\v Titel@d:/winhelp/udo.hlp}

else:     UDO (or Atari)
</pre>
</blockquote>
<p>How to use external links inside an HTML file is descriped in the
following example:
</p>
<blockquote>
<pre>""(!xlink [Yahoo] [http://www.yahoo.com])<a href="_f016.html#UDO__21..">!..</a>""
<a href="_f00d.html#UDO__28_21nl_29">(!nl)</a>
""(!xlink [Web.De] [http://web.de])<a href="_f016.html#UDO__21..">!..</a>""
</pre>
</blockquote>
<p>... will be displayed this way:
</p>
<blockquote>
<p>&quot;<a href="http://www.yahoo.com">Yahoo</a>...&quot;
<br>&quot;<a href="http://web.de">Web.De</a>...&quot;
</p>
</blockquote>
<p><b>Please note:</b>
</p>
<ol>
<li> You have to use existing topic names for Windows Help. A topic
name must contain only numbers and characters form the alphabet. All
other characters will be converted by UDO.
<br>&nbsp;
</li>
<li> You should use `<tt>*:\</tt>' at the beginning of an external link
for the ST-Guide to tell it to look for the hypertext in all
directories you defined with <tt>PATHS</tt> in your
<tt>ST-GUIDE.INF</tt>.
<br>&nbsp;
</li>
<li> Using the switch called <i><a href="_f00d.html#UDO__21no_xlinks">!no_xlinks</a>&nbsp;[...]</i> you can
suppress the conversion of external links. This is useful if you wrote
a source file especially for HTML and you want to make a version for
Windows Help or ST-Guide, where the external file wouldn't make no
sense.
<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="005007.html"><img src="udo_lf.gif" alt="Images" border="0" width="24" height="24"></a>
<a href="005009.html"><img src="udo_rg.gif" alt="Miscellaneous" border="0" width="24" height="24"></a>
</body></html>
udo-doc-en 6.4.1-1 / usr / share / doc / udo-doc-en / html / 005008.html
