Document Conventions

The Bugzilla Guide - 3.6.8 Release
Prev | Chapter 1. About This Guide | Next

# 1.5. Document Conventions

This document uses the following conventions:

Descriptions | Appearance
--- | ---
Caution |
| Don't run with scissors!
Hint or Tip |
| For best results...
Note |
| Dear John...
Warning |
| Read this or the cat gets it.
File or directory name | `filename`
Command to be typed | command
Application name | application
Normal user's prompt under bash shell | bash$
Root user's prompt under bash shell | bash#
Normal user's prompt under tcsh shell | tcsh$
Environment variables | `VARIABLE`
Term found in the glossary | Bugzilla
Code example |
    <para>
    Beginning and end of paragraph
    </para>

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 Bugzilla Documentation component.

Prev | Home | Next
Credits | Up | Installing Bugzilla