3b5e8524aa
r=kiko r=mkanat r=mrbball a=LpSolit git-svn-id: svn://10.0.0.236/trunk@263258 18797224-902f-48f8-a5cc-f745e15eee43
92 lines
2.5 KiB
XML
92 lines
2.5 KiB
XML
<?xml version="1.0"?>
|
|
<!-- This Source Code Form is subject to the terms of the Mozilla Public
|
|
License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
|
|
This Source Code Form is "Incompatible With Secondary Licenses", as
|
|
defined by the Mozilla Public License, v. 2.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>
|
|
|
|
<para>This document uses the following conventions:</para>
|
|
|
|
<caution>
|
|
<para>This is a caution. Make sure to read this to not be in trouble!</para>
|
|
</caution>
|
|
|
|
<tip>
|
|
<para>This is a hint or tip, especially about some configuration tweaks.</para>
|
|
</tip>
|
|
|
|
<note>
|
|
<para>This is just a note, for your information.</para>
|
|
</note>
|
|
|
|
<warning>
|
|
<para>This is a warning, something you should take care of.</para>
|
|
</warning>
|
|
|
|
<para>
|
|
A filename or a path to a filename is displayed like this:
|
|
<filename>/path/to/filename.ext</filename>
|
|
</para>
|
|
|
|
<para>
|
|
A command to type in the shell is displayed like this:
|
|
<command>command --arguments</command>
|
|
</para>
|
|
|
|
<para>bash$ represents a normal user's prompt under bash shell</para>
|
|
|
|
<para>bash# represents a root user's prompt under bash shell</para>
|
|
|
|
<para>
|
|
A word which is in the glossary will appear like this:
|
|
<glossterm linkend="gloss-bugzilla">Bugzilla</glossterm>
|
|
</para>
|
|
|
|
<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.2 XML format.
|
|
Changes are best submitted as plain text or XML diffs, attached
|
|
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
|
|
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.xml" "book" "chapter")
|
|
sgml-shorttag:t
|
|
sgml-tag-region-if-active:t
|
|
End:
|
|
-->
|