blob: 934bacb34612bc9cff591aefaad6807463e16340 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML
><HEAD
><TITLE
>Document Conventions</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="HOME"
TITLE="The Bugzilla Guide - 2.20.1
Release"
HREF="index.html"><LINK
REL="UP"
TITLE="About This Guide"
HREF="about.html"><LINK
REL="PREVIOUS"
TITLE="Credits"
HREF="credits.html"><LINK
REL="NEXT"
TITLE="Installing Bugzilla"
HREF="installing-bugzilla.html"></HEAD
><BODY
CLASS="section"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>The Bugzilla Guide - 2.20.1
Release</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="credits.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 1. About This Guide</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="installing-bugzilla.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="conventions"
>1.5. Document Conventions</A
></H1
><P
>This document uses the following conventions:</P
><DIV
CLASS="informaltable"
><P
></P
><A
NAME="AEN115"
></A
><TABLE
BORDER="0"
FRAME="void"
CLASS="CALSTABLE"
><COL><COL><THEAD
><TR
><TH
>Descriptions</TH
><TH
>Appearance</TH
></TR
></THEAD
><TBODY
><TR
><TD
>Warning</TD
><TD
>&#13; <DIV
CLASS="caution"
><P
></P
><TABLE
CLASS="caution"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/caution.gif"
HSPACE="5"
ALT="Caution"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>Don't run with scissors!</P
></TD
></TR
></TABLE
></DIV
>
</TD
></TR
><TR
><TD
>Hint</TD
><TD
>&#13; <DIV
CLASS="tip"
><P
></P
><TABLE
CLASS="tip"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>Would you like a breath mint?</P
></TD
></TR
></TABLE
></DIV
>
</TD
></TR
><TR
><TD
>Note</TD
><TD
>&#13; <DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>Dear John...</P
></TD
></TR
></TABLE
></DIV
>
</TD
></TR
><TR
><TD
>Information requiring special attention</TD
><TD
>&#13; <DIV
CLASS="warning"
><P
></P
><TABLE
CLASS="warning"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/warning.gif"
HSPACE="5"
ALT="Warning"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>Read this or the cat gets it.</P
></TD
></TR
></TABLE
></DIV
>
</TD
></TR
><TR
><TD
>File or directory name</TD
><TD
>&#13; <TT
CLASS="filename"
>filename</TT
>
</TD
></TR
><TR
><TD
>Command to be typed</TD
><TD
>&#13; <B
CLASS="command"
>command</B
>
</TD
></TR
><TR
><TD
>Application name</TD
><TD
>&#13; <SPAN
CLASS="application"
>application</SPAN
>
</TD
></TR
><TR
><TD
>&#13; Normal user's prompt under bash shell</TD
><TD
>bash$</TD
></TR
><TR
><TD
>&#13; Root user's prompt under bash shell</TD
><TD
>bash#</TD
></TR
><TR
><TD
>&#13; Normal user's prompt under tcsh shell</TD
><TD
>tcsh$</TD
></TR
><TR
><TD
>Environment variables</TD
><TD
>&#13; <VAR
CLASS="envar"
>VARIABLE</VAR
>
</TD
></TR
><TR
><TD
>Term found in the glossary</TD
><TD
>&#13; <A
HREF="glossary.html#gloss-bugzilla"
><I
CLASS="glossterm"
>Bugzilla</I
></A
>
</TD
></TR
><TR
><TD
>Code example</TD
><TD
>&#13; <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
><CODE
CLASS="sgmltag"
>&#60;para&#62;</CODE
>
Beginning and end of paragraph
<CODE
CLASS="sgmltag"
>&#60;/para&#62;</CODE
></PRE
></FONT
></TD
></TR
></TABLE
>
</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
><P
>
This documentation is maintained in DocBook 4.1.2 XML format.
Changes are best submitted as plain text or XML diffs, attached
to a bug filed in the <A
HREF="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&#38;component=Documentation"
TARGET="_top"
>Bugzilla Documentation</A
> component.
</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="credits.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="installing-bugzilla.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Credits</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="about.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Installing Bugzilla</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>