/[texi2html]/texi2html/Tests/nodes_texinfo_res/Tips.html
ViewVC logotype

Diff of /texi2html/Tests/nodes_texinfo_res/Tips.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.20 by pertusus, Tue Aug 9 17:19:22 2005 UTC revision 1.21 by pertusus, Tue Aug 23 23:51:14 2005 UTC
# Line 90  ul.toc {list-style: none} Line 90  ul.toc {list-style: none}
90  Write in the present tense, not in the past or the future.  Write in the present tense, not in the past or the future.
91    
92  </li><li>  </li><li>
93  Write actively!  For example, write &quot;We recommend that &hellip;&quot; rather  Write actively!  For example, write &ldquo;We recommend that &hellip;&rdquo; rather
94  than &quot;It is recommended that &hellip;&quot;.  than &ldquo;It is recommended that &hellip;&rdquo;.
95    
96  </li><li>  </li><li>
97  Use 70 or 72 as your fill column.  Longer lines are hard to read.  Use 70 or 72 as your fill column.  Longer lines are hard to read.
# Line 121  place in the document. Line 121  place in the document.
121    
122  </li><li>  </li><li>
123  Write index entries only where a topic is discussed significantly.  For  Write index entries only where a topic is discussed significantly.  For
124  example, it is not useful to index &quot;debugging information&quot; in a  example, it is not useful to index &ldquo;debugging information&rdquo; in a
125  chapter on reporting bugs.  Someone who wants to know about debugging  chapter on reporting bugs.  Someone who wants to know about debugging
126  information will certainly not find it in that chapter.  information will certainly not find it in that chapter.
127    
# Line 144  after the section command, and write the Line 144  after the section command, and write the
144  a paragraph before that paragraph.  a paragraph before that paragraph.
145    
146  <p>In the example that follows, a blank line comes after the index  <p>In the example that follows, a blank line comes after the index
147  entry for &quot;Leaping&quot;:  entry for &ldquo;Leaping&rdquo;:
148  </p>  </p>
149  <table><tr><td>&nbsp;</td><td><pre class="example">@section The Dog and the Fox  <table><tr><td>&nbsp;</td><td><pre class="example">@section The Dog and the Fox
150  @cindex Jumping, in general  @cindex Jumping, in general
# Line 158  The quick brown fox jumps over the lazy Line 158  The quick brown fox jumps over the lazy
158  </pre></td></tr></table>  </pre></td></tr></table>
159    
160  <p>(Note that the example shows entries for the same concept that are  <p>(Note that the example shows entries for the same concept that are
161  written in different ways--<samp>`Lazy dog'</samp>, and <samp>`Dog, lazy'</samp>--so  written in different ways&mdash;<samp>`Lazy dog'</samp>, and <samp>`Dog, lazy'</samp>&mdash;so
162  readers can look up the concept in different ways.)  readers can look up the concept in different ways.)
163  </p></li></ul>  </p></li></ul>
164    
# Line 211  this. Line 211  this.
211    
212  </li><li>  </li><li>
213  Write the prefatory sentence or phrase for a multi-item list or table as  Write the prefatory sentence or phrase for a multi-item list or table as
214  a complete expression.  Do not write &quot;You can set:&quot;; instead, write  a complete expression.  Do not write &ldquo;You can set:&rdquo;; instead, write
215  &quot;You can set these variables:&quot;.  The former expression sounds cut off.  &ldquo;You can set these variables:&rdquo;.  The former expression sounds cut off.
216  </li></ul>  </li></ul>
217    
218  <a name="SEC282"></a>  <a name="SEC282"></a>
# Line 252  commands. Line 252  commands.
252    
253  <ul>  <ul>
254  <li>  <li>
255  Capitalize &quot;Texinfo&quot;; it is a name.  Do not write the <samp>`x'</samp> or  Capitalize &ldquo;Texinfo&rdquo;; it is a name.  Do not write the <samp>`x'</samp> or
256  <samp>`i'</samp> in upper case.  <samp>`i'</samp> in upper case.
257    
258  </li><li>  </li><li>
259  Capitalize &quot;Info&quot;; it is a name.  Capitalize &ldquo;Info&rdquo;; it is a name.
260    
261  </li><li>  </li><li>
262  Write TeX using the <code>@TeX{}</code> command.  Note the uppercase  Write TeX using the <code>@TeX{}</code> command.  Note the uppercase
# Line 340  outside the end quotation marks: Line 340  outside the end quotation marks:
340  Introduce new terms so that a reader who does not know them can  Introduce new terms so that a reader who does not know them can
341  understand them from context; or write a definition for the term.  understand them from context; or write a definition for the term.
342    
343  <p>For example, in the following, the terms &quot;check in&quot;, &quot;register&quot; and  <p>For example, in the following, the terms &ldquo;check in&rdquo;, &ldquo;register&rdquo; and
344  &quot;delta&quot; are all appearing for the first time; the example sentence should be  &ldquo;delta&rdquo; are all appearing for the first time; the example sentence should be
345  rewritten so they are understandable.  rewritten so they are understandable.
346  </p>  </p>
347  <blockquote><p>The major function assists you in checking in a file to your  <blockquote><p>The major function assists you in checking in a file to your
# Line 411  beginning of the section that describes Line 411  beginning of the section that describes
411    
412  <p>Here are several examples of bad writing to avoid:  <p>Here are several examples of bad writing to avoid:
413  </p>  </p>
414  <p>In this example, say, &quot; &hellip; you must <code>@dfn</code>{check  <p>In this example, say, &ldquo; &hellip; you must <code>@dfn</code>{check
415  in} the new version.&quot;  That flows better.  in} the new version.&rdquo;  That flows better.
416  </p>  </p>
417  <blockquote><p>When you are done editing the file, you must perform a  <blockquote><p>When you are done editing the file, you must perform a
418  <code>@dfn</code>{check in}.  <code>@dfn</code>{check in}.
419  </p></blockquote>  </p></blockquote>
420    
421  <p>In the following example, say, &quot;&hellip; makes a unified interface such as VC  <p>In the following example, say, &ldquo;&hellip; makes a unified interface such as VC
422  mode possible.&quot;  mode possible.&rdquo;
423  </p>  </p>
424  <blockquote><p>SCCS, RCS and other version-control systems all perform similar  <blockquote><p>SCCS, RCS and other version-control systems all perform similar
425  functions in broadly similar ways (it is this resemblance which makes  functions in broadly similar ways (it is this resemblance which makes
# Line 439  everyone's changes so they do not step o Line 439  everyone's changes so they do not step o
439  <li>  <li>
440  Pronounce TeX as if the <samp>`X'</samp> were a Greek `chi', as the last  Pronounce TeX as if the <samp>`X'</samp> were a Greek `chi', as the last
441  sound in the name `Bach'.  But pronounce Texinfo as in `speck':  sound in the name `Bach'.  But pronounce Texinfo as in `speck':
442  &quot;teckinfo&quot;.  &ldquo;teckinfo&rdquo;.
443    
444  </li><li>  </li><li>
445  Write notes for yourself at the very end of a Texinfo file after the  Write notes for yourself at the very end of a Texinfo file after the

Legend:
Removed from v.1.20  
changed lines
  Added in v.1.21

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26