329d63ee04
* Bug 191971 - The guide incorrectly stated that you could resolve a bug via email * Provide an example of a glossary term in the document conventions section git-svn-id: svn://10.0.0.236/trunk@137463 18797224-902f-48f8-a5cc-f745e15eee43
180 lines
3.7 KiB
XML
180 lines
3.7 KiB
XML
<!-- <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
|
|
<section id="conventions">
|
|
<title>Document Conventions</title>
|
|
|
|
<indexterm zone="conventions">
|
|
<primary>conventions</primary>
|
|
</indexterm>
|
|
|
|
<para>This document uses the following conventions:</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>Don't run with scissors!</para>
|
|
</caution>
|
|
</entry>
|
|
</row>
|
|
|
|
<row>
|
|
<entry>Hint</entry>
|
|
|
|
<entry>
|
|
<tip>
|
|
<para>Would you like a breath mint?</para>
|
|
</tip>
|
|
</entry>
|
|
</row>
|
|
|
|
<row>
|
|
<entry>Notes</entry>
|
|
|
|
<entry>
|
|
<note>
|
|
<para>Dear John...</para>
|
|
</note>
|
|
</entry>
|
|
</row>
|
|
|
|
<row>
|
|
<entry>Information requiring special attention</entry>
|
|
|
|
<entry>
|
|
<warning>
|
|
<para>Read this or the cat gets it.</para>
|
|
</warning>
|
|
</entry>
|
|
</row>
|
|
|
|
<row>
|
|
<entry>File Names</entry>
|
|
|
|
<entry>
|
|
<filename>filename</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>Term found in the glossary</entry>
|
|
|
|
<entry>
|
|
<glossterm linkend="gloss-bugzilla">Bugzilla</glossterm>
|
|
</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>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-always-quote-attributes:t
|
|
sgml-auto-insert-required-elements:t
|
|
sgml-balanced-tag-edit:t
|
|
sgml-exposed-tags:nil
|
|
sgml-general-insert-case:lower
|
|
sgml-indent-data:t
|
|
sgml-indent-step:2
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
sgml-minimize-attributes:nil
|
|
sgml-namecase-general:t
|
|
sgml-omittag:t
|
|
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
|
|
sgml-shorttag:t
|
|
sgml-tag-region-if-active:t
|
|
End:
|
|
-->
|
|
|