[phpBT-dev] CVS: phpbt/docs/sgml bugdetail.sgml,NONE,1.1 phpbt.sgml,1.7,1.8

[Benjamin C. <bc...@us...>]

Update of /cvsroot/phpbt/phpbt/docs/sgml
In directory usw-pr-cvs1:/tmp/cvs-serv20584/sgml

Modified Files:
	phpbt.sgml 
Added Files:
	bugdetail.sgml 
Log Message:
Added the bug detail section

--- NEW FILE: bugdetail.sgml ---
<!-- -*- sgml -*- -->
<sect1 id="bugdetail">
<title>Working with Bugs</title>

<para>The majority of the time you spend with &phpbt; will probably be on the bug detail page.  This page shows you all the information about a bug, and allows you to change most of it.  </para>

<screenshot>
<screeninfo>Bug Detail</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="images/shots/user/bugdetail.png" format="PNG">
</imageobject>
<imageobject>
<imagedata fileref="images/shots/user/bugdetail.jpg" format="JPG">
</imageobject>
<imageobject>
<imagedata fileref="images/shots/user/bugdetail.eps" format="EPS" align="center">
</imageobject>
<textobject>
<phrase>Screen shot of editing a bug.</phrase>
</textobject>
<caption>
<para>Editing a bug.</para>
</caption>
</mediaobject>
</screenshot>

<para>When changes are made to a bug, an email is sent to the person who reported it and to the person to whom the bug is assigned.  However, email is not sent to the person who is making the changes to the bug.  So, if a bug has been submitted and assigned to a developer, and then the developer adds comments to the bug, then those comments will be emailed to the reporter but not to the developer.  Additional people can be added to receive these change emails by adding them to the CC list.  To remove people from the CC list, simply select the people to be removed and submit the form.</para>

<para>The set of radio buttons beneath the <guilabel>Update Bug Status</guilabel> label changes depending on the status of the bug.  The bug in the screen shot is one that has been newly submitted, so it is unassigned at the moment.  If a developer looking at this bug wanted to take ownership, she would click <guilabel>Accept bug</guilabel> and then submit the form.  If a bug is resolved as a duplicate of another bug (e.g, bug #77), it will be closed and a comment will be added to this bug and to bug #77 noting that this bug is a duplicate of that one.  If there is a developer assigned to be the owner of this component (in this case, "name test"), then the bug can be assigned to that individual by clicking the last radio button.</para>

<para>Files can be added to a bug as attachments by clicking on the <guilabel role="hyperlink">Create Attachment</guilabel> link.  This will bring up another form where you can supply a short description and browse for the file to be uploaded.  Attachments can be viewed (and can be deleted by administrators) from the attachment list.</para>

<para>Adding comments to a bug allows you to provide more detail about what caused the bug or what the expected behavior was, but also allow the developer and the user to communicate about a bug while keeping a history of those notes.  Comments that are added to a bug will be emailed as described previously.  HTML tags will be stripped from the comments, but there are two special character sequences that can be used to create links when the comments are displayed:</para>

<itemizedlist>
<listitem>
<para><userinput>bug #<replaceable>nn</replaceable></userinput> : Causes a link to be created to the numbered bug in &phpbt;.</para>
</listitem>
<listitem>
<para><userinput>cvs:<filename><replaceable>path/filename.ext</replaceable></filename><optional>:<replaceable>v.vv</replaceable></optional></userinput> : Creates a link to a view of the specified source file in the CVS web interface specified in the configuration.  The CVS version number is optional, so the format would be <userinput>cvs:<filename><replaceable>path/filename.ext</replaceable></filename></userinput> if the version isn't specified.</para>
</listitem>
</itemizedlist>

</sect1>

<!-- Local Variables: -->
<!-- sgml-parent-document: "phpbt.sgml" -->
<!-- End: -->

Index: phpbt.sgml
===================================================================
RCS file: /cvsroot/phpbt/phpbt/docs/sgml/phpbt.sgml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- phpbt.sgml	2001/10/17 04:02:28	1.7
+++ phpbt.sgml	2001/10/17 13:44:10	1.8
@@ -8,6 +8,7 @@
 <!-- User's Guide -->
 <!ENTITY primer SYSTEM "primer.sgml">
 <!ENTITY bugsearch SYSTEM "bugsearch.sgml">
+<!ENTITY bugdetail SYSTEM "bugdetail.sgml">
 
 <!-- Administrator's Guide -->
 <!ENTITY installation SYSTEM "installation.sgml">
@@ -35,6 +36,7 @@
 
 &primer;
 &bugsearch;
+&bugdetail;
 
 </chapter>