<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968"><title>1.5. Document Conventions</title><link rel="stylesheet" type="text/css" href="../../style.css"><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><meta name="keywords" content="Bugzilla, Guide, installation, FAQ, administration, integration, MySQL, Mozilla, webtools"><link rel="home" href="index.html" title="The Bugzilla Guide - 4.4.11 Release"><link rel="up" href="about.html" title="Chapter 1. About This Guide"><link rel="prev" href="credits.html" title="1.4. Credits"><link rel="next" href="installing-bugzilla.html" title="Chapter 2. Installing Bugzilla"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">1.5. Document Conventions</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="credits.html">Prev</a> </td><th width="60%" align="center">Chapter 1. About This Guide</th><td width="20%" align="right"> <a accesskey="n" href="installing-bugzilla.html">Next</a></td></tr></table><hr></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="conventions"></a>1.5. Document Conventions</h2></div></div></div><p>This document uses the following conventions:</p><div class="caution" style="margin-left: 1em; margin-right: 1em"><table border="0" summary="Caution"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="../images/caution.gif"></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>This is a caution. Make sure to read this to not be in trouble!</p></td></tr></table></div><div class="tip" style="margin-left: 1em; margin-right: 1em"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../images/tip.gif"></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>This is a hint or tip, especially about some configuration tweaks.</p></td></tr></table></div><div class="note" style="margin-left: 1em; margin-right: 1em"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.gif"></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>This is just a note, for your information.</p></td></tr></table></div><div class="warning" style="margin-left: 1em; margin-right: 1em"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../images/warning.gif"></td><th align="left"></th></tr><tr><td align="left" valign="top"><p>This is a warning, something you should take care of.</p></td></tr></table></div><p>
A filename or a path to a filename is displayed like this:
<code class="filename">/path/to/filename.ext</code>
</p><p>
A command to type in the shell is displayed like this:
<span class="command"><strong>command --arguments</strong></span>
</p><p>bash$ represents a normal user's prompt under bash shell</p><p>bash# represents a root user's prompt under bash shell</p><p>
A word which is in the glossary will appear like this:
<a class="glossterm" href="glossary.html#gloss-bugzilla"><em class="glossterm">Bugzilla</em></a>
</p><p>
A sample of code is illustrated like this:
</p><pre class="programlisting">
First Line of Code
Second Line of Code
...
</pre><p>
</p><p>
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 <a class="ulink" href="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla;component=Documentation" target="_top">Bugzilla Documentation</a>
component.
</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="credits.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="about.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="installing-bugzilla.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">1.4. Credits </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 2. Installing Bugzilla</td></tr></table></div></body></html>
