summaryrefslogtreecommitdiffstats
path: root/docs/sgml/conventions.sgml
diff options
context:
space:
mode:
authorbarnboy%trilobyte.net <>2001-03-08 14:35:44 +0100
committerbarnboy%trilobyte.net <>2001-03-08 14:35:44 +0100
commit6b607da839992bead01d7cba308f216e17eed520 (patch)
treedce2e5e7aac71ccb906eb18b292712e93cd1ed85 /docs/sgml/conventions.sgml
parent3208181dc05fa0633e6cde53fec641f1db4b35ef (diff)
downloadbugzilla-6b607da839992bead01d7cba308f216e17eed520.tar.gz
bugzilla-6b607da839992bead01d7cba308f216e17eed520.tar.xz
Documentation update; added docs/sgml, docs/html, docs/txt.
No text version of The Bugzilla Guide availabe yet, however.
Diffstat (limited to 'docs/sgml/conventions.sgml')
-rw-r--r--docs/sgml/conventions.sgml111
1 files changed, 111 insertions, 0 deletions
diff --git a/docs/sgml/conventions.sgml b/docs/sgml/conventions.sgml
new file mode 100644
index 000000000..66f72303c
--- /dev/null
+++ b/docs/sgml/conventions.sgml
@@ -0,0 +1,111 @@
+<!-- <!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>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>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-namecase-general:t
+sgml-general-insert-case:upper
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:2
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+-->
+
+
+