diff options
Diffstat (limited to 'docs/en/xml/conventions.xml')
| -rw-r--r-- | docs/en/xml/conventions.xml | 169 |
1 files changed, 45 insertions, 124 deletions
diff --git a/docs/en/xml/conventions.xml b/docs/en/xml/conventions.xml index 70e6624f7..6a8f8b47e 100644 --- a/docs/en/xml/conventions.xml +++ b/docs/en/xml/conventions.xml @@ -1,144 +1,65 @@ -<!-- <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> +<?xml version="1.0"?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + <!ENTITY % myents SYSTEM "bugzilla.ent"> + %myents; +]> + <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>Caution</entry> - - <entry> - <caution> - <para>Don't run with scissors!</para> - </caution> - </entry> - </row> - - <row> - <entry>Hint or Tip</entry> - - <entry> - <tip> - <para>For best results... </para> - </tip> - </entry> - </row> - - <row> - <entry>Note</entry> - - <entry> - <note> - <para>Dear John...</para> - </note> - </entry> - </row> - - <row> - <entry>Warning</entry> - - <entry> - <warning> - <para>Read this or the cat gets it.</para> - </warning> - </entry> - </row> - - <row> - <entry>File or directory name</entry> + <caution> + <para>This is a caution. Make sure to read this to not be in trouble!</para> + </caution> - <entry> - <filename>filename</filename> - </entry> - </row> + <tip> + <para>This is a hint or tip, especially about some configuration tweaks.</para> + </tip> - <row> - <entry>Command to be typed</entry> + <note> + <para>This is just a note, for your information.</para> + </note> - <entry> - <command>command</command> - </entry> - </row> + <warning> + <para>This is a warning, something you should take care of.</para> + </warning> - <row> - <entry>Application name</entry> - - <entry> - <application>application</application> - </entry> - </row> - - <row> - <entry> - Normal user's prompt under bash shell</entry> - - <entry>bash$</entry> - </row> - - <row> - <entry> - Root user's prompt under bash shell</entry> - - <entry>bash#</entry> - </row> - - <row> - <entry> - Normal user's prompt under tcsh shell</entry> - - <entry>tcsh$</entry> - </row> - - <row> - <entry>Environment variables</entry> + <para> + A filename or a path to a filename is displayed like this: + <filename>/path/to/filename.ext</filename> + </para> - <entry> - <envar>VARIABLE</envar> - </entry> - </row> + <para> + A command to type in the shell is displayed like this: + <command>command --arguments</command> + </para> - <row> - <entry>Term found in the glossary</entry> + <para>bash$ represents a normal user's prompt under bash shell</para> - <entry> - <glossterm linkend="gloss-bugzilla">Bugzilla</glossterm> - </entry> - </row> + <para>bash# represents a root user's prompt under bash shell</para> - <row> - <entry>Code example</entry> + <para> + A word which is in the glossary will appear like this: + <glossterm linkend="gloss-bugzilla">Bugzilla</glossterm> + </para> - <entry> - <programlisting><sgmltag class="starttag">para</sgmltag> -Beginning and end of paragraph -<sgmltag class="endtag">para</sgmltag></programlisting> - </entry> - </row> - </tbody> - </tgroup> - </informaltable> + <para> + A sample of code is illustrated like this: + <programlisting> +First Line of Code +Second Line of Code +... + </programlisting> + </para> - <para> - This documentation is maintained in DocBook 4.1.2 XML format. + <para> + This documentation is maintained in DocBook 4.2 XML format. Changes are best submitted as plain text or XML diffs, attached - to a bug filed in the &bzg-bugs; component. + to a bug filed in the <ulink url="&bzg-bugs;">Bugzilla Documentation</ulink> + component. </para> - </section> <!-- Keep this comment at the end of the file |