LDP/LDP/guide/docbook/LDP-Author-Guide/obsolete/conventions.sgml

97 lines
3.0 KiB
Plaintext

<!-- <!doctype section PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> -->
<section id="conventions"><?dbhtml filename="conventions.html">
<title>Documents</title>
<indexterm zone="conventions">
<primary>conventions</primary>
</indexterm>
<para>This document uses the following conventions<footnote>
<para>Please, take a look at the <ulink
url="http://cvsweb.linuxdoc.org/index.cgi/LDP/guide/docbook/LDP-Author-Guide/">
source</ulink> to see how to get
similar results on your documents. You should also remember that
the way this appears to you depends on the format you're reading
this document: online appearance is slightly different from the
PostScript or PDF ones.</para></footnote>:</para>
<informaltable frame="none">
<tgroup cols="2">
<thead>
<row>
<entry>Descriptions</entry>
<entry>Appearance</entry>
</row>
</thead>
<tbody>
<row>
<entry>Warnings</entry>
<entry><caution>
<para>Warnings.</para>
</caution></entry>
</row>
<row>
<entry>Hint</entry>
<entry><tip>
<para>Hint.</para>
</tip></entry>
</row>
<row>
<entry>Notes</entry>
<entry><note>
<para>Note.</para>
</note></entry>
</row>
<row>
<entry>Information requiring special attention</entry>
<entry><warning>
<para>Warning.</para>
</warning></entry>
</row>
<row>
<entry>File Names</entry>
<entry><filename>file.extension</filename></entry>
</row>
<row>
<entry>Directory Names</entry>
<entry><filename class="directory">directory</filename></entry>
</row>
<row>
<entry>Commands to be typed</entry>
<entry><command>command</command></entry>
</row>
<row>
<entry>Applications Names</entry>
<entry><application>application</application></entry>
</row>
<row>
<entry><foreignphrase>Prompt</foreignphrase> of users command under bash shell</entry>
<entry>bash$</entry>
</row>
<row>
<entry><foreignphrase>Prompt</foreignphrase> of root users command under bash shell</entry>
<entry>bash#</entry>
</row>
<row>
<entry><foreignphrase>Prompt</foreignphrase> of user command under tcsh shell</entry>
<entry>tcsh$</entry>
</row>
<row>
<entry>Environment Variables</entry>
<entry><envar>VARIABLE</envar></entry>
</row>
<row>
<entry>Emphasized word</entry>
<entry><emphasis>word</emphasis></entry>
</row>
<row>
<entry>Code Example</entry>
<entry><programlisting><sgmltag class="starttag">para</sgmltag>Beginning and end of paragraph<sgmltag class="endtag">para</sgmltag></programlisting></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>