userguide.html at phpBugTracker

<HTML
><HEAD
><TITLE
>User's Guide</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
"><LINK
REL="HOME"
TITLE="phpBugTracker"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="phpBugTracker"
HREF="index.html"><LINK
REL="NEXT"
TITLE="Searching the Bug Database"
HREF="bugsearch.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="docs.css"></HEAD
><BODY
CLASS="CHAPTER"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#800080"
ALINK="#FF0000"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>phpBugTracker</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="index.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="bugsearch.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="CHAPTER"
><H1
><A
NAME="USERGUIDE">Chapter 1. User's Guide</H1
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
>1.1. <A
HREF="userguide.html#PRIMER"
>Getting Started</A
></DT
><DD
><DL
><DT
>1.1.1. <A
HREF="userguide.html#CREATEACCOUNT"
>Creating an account</A
></DT
><DT
>1.1.2. <A
HREF="userguide.html#ENTERBUG"
>Entering a bug</A
></DT
></DL
></DD
><DT
>1.2. <A
HREF="bugsearch.html"
>Searching the Bug Database</A
></DT
><DT
>1.3. <A
HREF="bugdetail.html"
>Working with Bugs</A
></DT
></DL
></DIV
><BLOCKQUOTE
CLASS="ABSTRACT"
><DIV
CLASS="ABSTRACT"
><A
NAME="AEN8"><P
>Currently all interactions with phpBugTracker are done via the web interface.  Users can submit bugs, communicate with developers and testers about bugs, and search through the bug database.</P
></DIV
></BLOCKQUOTE
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="PRIMER">1.1. Getting Started</H1
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="CREATEACCOUNT">1.1.1. Creating an account</H2
><P
>You can create a new account by following the link labeled <SPAN
CLASS="bold"
><B
CLASS="EMPHASIS"
>Create a new account</B
></SPAN
>.  To create a new account you will need to enter at least a valid email address (so that your password can be mailed to you).  Providing your name is optional, but if you submit it then your name will appear with bugs you submit and comments you make.  If the system has been configured to use a login separate from the email address, you will also be prompted for a login.  If you have chosen an email address (or login) that is already in use, you will be prompted to choose a different one.  After completing this form, your password will be mailed to you.  Once you have received your password you can then login with your email (or login) and password to be able to submit bugs.</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="ENTERBUG">1.1.2. Entering a bug</H2
><P
>Once you have logged in to the system you can follow the <SPAN
CLASS="bold"
><B
CLASS="EMPHASIS"
>Add a New Bug</B
></SPAN
> link from the top navigation bar to create a new bug.  If there is more than one project for which you can submit a bug, you will be prompted to choose one.</P
><DIV
CLASS="MEDIAOBJECT"
><P
><IMG
SRC="images/shots/user/enterbug-chooseproject.jpg"><DIV
CLASS="CAPTION"
><P
>Selecting a project for a bug report.</P
></DIV
></P
></DIV
><P
>Once you have chosen a project, or if there is only one project in the system, you will see the bug entry page.  The <SPAN
CLASS="bold"
><B
CLASS="EMPHASIS"
>Version</B
></SPAN
> and <SPAN
CLASS="bold"
><B
CLASS="EMPHASIS"
>Component</B
></SPAN
> fields allow you to specify details about which part or version of the product that produces this bug.  The <SPAN
CLASS="bold"
><B
CLASS="EMPHASIS"
>Summary</B
></SPAN
> field should be a short but specific summary of the problem, while the <SPAN
CLASS="bold"
><B
CLASS="EMPHASIS"
>Description</B
></SPAN
> field should include details about the behavior observed, how that behavior differs from expected behavior, and the steps to reproduce the problem.  If the product being tested is web-based, you can use the <SPAN
CLASS="bold"
><B
CLASS="EMPHASIS"
>URL</B
></SPAN
> field to provide a link directly to the problem.  The <SPAN
CLASS="bold"
><B
CLASS="EMPHASIS"
>Add another</B
></SPAN
> checkbox, if checked, will present another bug entry form when you submit a bug, instead of taking you to the bug list.</P
><DIV
CLASS="MEDIAOBJECT"
><P
><IMG
SRC="images/shots/user/enterbug-detail.jpg"><DIV
CLASS="CAPTION"
><P
>Entering a bug report.</P
></DIV
></P
></DIV
><P
>That's it!  The bug has been entered, and it's ready to be reviewed and fixed by the developers. ( phpBugTracker version 1.0.5 )</P
></DIV
></DIV
></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="index.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="bugsearch.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>phpBugTracker</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
>&nbsp;</TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Searching the Bug Database</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>