Document Conventions

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

# 1.5. Document Conventions

This document uses the following conventions:

Descriptions | Appearance
--- | ---
Use caution |
| Don't run with scissors!
Hint |
| Would you like a breath mint?
Notes |
| Dear John...
Warnings |
| Read this or the cat gets it.
File Names | `filename`
Directory Names | `directory`
Commands to be typed | command
Applications Names | application
Prompt of users command under bash shell | bash$
Prompt of root users command under bash shell | bash#
Prompt of user command under tcsh shell | tcsh$
Environment Variables | VARIABLE
Emphasized word | word
Term found in the glossary | Bugzilla
Code Example |
    <para>
    Beginning and end of paragraph
    </para>

Prev | Home | Next
Credits | Up | Introduction