udo-doc-en 6.4.1-3 / usr / share / doc / udo-doc-en / html / 006001.html

This file is indexed.

/usr/share/doc/udo-doc-en/html/006001.html is in udo-doc-en 6.4.1-3.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
        "http://www.w3.org/TR/html4/loose.dtd">
<!-- last modified on 2016/08/01 -->
<html lang="en">
<head>
<title>
The guide to UDO: Seven rules for writing UDO source files
</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="006002.html" title="General tips &amp; tricks">
<link rel="section" href="006003.html" title="Tips &amp; tricks according to LaTeX">
<link rel="section" href="006004.html" title="Tips &amp; tricks according to ST-Guide">
<link rel="section" href="006005.html" title="Tips &amp; tricks concerning Windows Help">
<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="006.html" title="Tips &amp; tricks">
<link rel="previous" href="006.html" title="Tips &amp; tricks">
<link rel="next" href="006002.html" title="General tips &amp; tricks">
<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="006.html"><img src="udo_up.gif" alt="Tips &amp; tricks" border="0" width="24" height="24"></a>
<a href="006.html"><img src="udo_lf.gif" alt="Tips &amp; tricks" border="0" width="24" height="24"></a>
<a href="006002.html"><img src="udo_rg.gif" alt="General tips &amp; tricks" border="0" width="24" height="24"></a>
<hr>
<h1><a name="Seven_20rules_20for_20writing_20UDO_20source_20files">Seven rules for writing UDO source files</a></h1>
<p>Before starting to write UDO source files you should take a look
at these rules and learn them by heart:
</p>
<ol>
<li> <b>Arrange your documentation clearly!</b>
<br>&nbsp;
</li>
<li> <b>Speak directly to the reader.</b>
<br>&nbsp;
<br>Use &quot;You can...&quot; instead of &quot;It's possible
to...&quot;.
<br>&nbsp;
</li>
<li> <b>Use text styles sparingly and homogeneously.</b>
<br>&nbsp;
<br>Don't use italic, bold and underlined text too often. But if you
use different text styles use them homogeneously. This documentations
prints all UDO command in italics, all filenames are printed with a
mono-spaced font.
<br>&nbsp;
</li>
<li> <b>Make it brief as possible.</b>
<br>&nbsp;
<br>Don't write novels, come straight to the point. If you don't the
reader may get bored while reading your manual.
<br>&nbsp;
<br>I have to admit that I'm not able to do this in some cases.
<TT>;-)</TT>
<br>&nbsp;
</li>
<li> <b>Use short chapter names.</b>
<br>&nbsp;
<br>If you use short chapter names the reader will find the chapter
more quickly after having read the table of contents. Furthermore you
can help UDO to insert hypertext links more quickly.
<br>&nbsp;
</li>
<li> <b>Avoid to use the same chapter name more than once.</b>
<br>&nbsp;
<br>If you use the same chapter name more than once UDO and the
hypertext compilers get confused. And you will confuse the reader,
too.
<br>&nbsp;
</li>
<li> <b>Use macros and definitions sparingly.</b>
<br>&nbsp;
<br>UDO has to look for macros and definitions twice in every line of
your source file. Any additional macro or definitions slows down the
conversion.
<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="006.html"><img src="udo_up.gif" alt="Tips &amp; tricks" border="0" width="24" height="24"></a>
<a href="006.html"><img src="udo_lf.gif" alt="Tips &amp; tricks" border="0" width="24" height="24"></a>
<a href="006002.html"><img src="udo_rg.gif" alt="General tips &amp; tricks" border="0" width="24" height="24"></a>
</body></html>

APT Browse - Built by Thomas Orozco.