updated documentation

git-svn-id: http://mantisbt.svn.sourceforge.net/svnroot/mantisbt/trunk@172 f5dc347c-c33d-0410-90a0-b07cc1902cb9

documentation.html

@@ -26,6 +26,9 @@ <h2>Part 1: Index</h2>
 <p>
 <ul>
 <li><a href="#login">Login</a>
+	<ul>
+	<li><a href="#signup">Signup</a>
+	</ul>
 <li><a href="#main">Main</a>
 <li><a href="#view_bugs">View Bugs</a>
 	<ul>
@@ -39,10 +42,11 @@ <h2>Part 1: Index</h2>
 	</ul>
 <li><a href="#editing_bugs">Editing Bugs</a>
 	<ul>
-	<li><a href="#delete_bug">Delete Bug</a>
-	<li><a href="#resolve_bug">Resolve Bug</a>
 	<li><a href="#update_bug_simple">Update Bug Simple</a>
 	<li><a href="#update_bug_advanced">Update Bug Advanced</a>
+	<li><a href="#assign_bug">Assign To Me</a>
+	<li><a href="#resolve_bug">Resolve Bug</a>
+	<li><a href="#delete_bug">Delete Bug</a>
 	</ul>
 <li><a href="#bugnotes">Bugnotes</a>
 	<ul>
@@ -63,9 +67,8 @@ <h2>Part 1: Index</h2>
 	</ul>
 <li><a href="#manage">Manage</a>
 	<ul>
-	<li><a href="#create_new_account">Create New Account</a>
-	<li><a href="#manage_categories">Manage Categories</a>
-	<li><a href="#manage_product_version">Manage Product Versions</a>
+	<li><a href="#create_account">Create Account</a>
+	<li><a href="#projects">Projects</a>
 	<li><a href="#documentation">Documentation</a>
 	</ul>
 <li><a href="#edit_news">Edit News</a>
@@ -84,20 +87,19 @@ <h3><a name=login>[ Login ]</a></h3>
 This is the login page.  Just enter your username and password and hit the login button.  There is also a <u>Save Login</u> checkbox to have the package remember that you are logged in between browser sessions.  You will have to have cookies enabled to login.
 <p>
 If the account doesn't exist, the account is disabled, or the password is incorrect you will be forwarded to a re-login screen.
-
 <p>
-<i>*** Suggested feature</i>: <u>Session support</u> :
-<blockquote>
-This would allow those that dislike cookies or are behind very unfriendly firewalls/proxies to be able to use the package.  Sessions requires PHP4.
-</blockquote>
-
+The administrator may allow users to sign up for their own accounts.  If so a link to <a href="#signup">Signup</a> for your own account will be available.
 <p>
-<i>*** Suggested feature</i>: <u>New account creation</u> :
+Sessions will probably not be used for some time.  PHP3 does not support sessions and, since it is still very widely used, we will not be using sessions.
+<p>
+You will specify the project you want to have selected when you login.  You can easily change this later on from inside the package.
+
 <blockquote>
-Let new users create their own accounts.  This would require an <a href="#email_module">email module</a> to work.  The email module would mail the new user a randomly generated password.  This can, of course, be changed after login.
+<h4><a name=signup>[ Signup ]</a></h4>
+<p>
+Here you can signup for a new account.  You must supply a valid email address and select a unique username.  Your randomly generated password will be emailed to your email account.
 </blockquote>
 
-
 <!-- ---------------------------------------------------------------------- -->
 <p>
 <h3><a name=main>[ Main ]</a></h3>
@@ -114,7 +116,7 @@ <h3><a name=view_bugs>[ View Bugs ]</a></h3>
 <p>
 <h5>Filters</h5>
 <p>
-The filters control the behavior of the Bug List.  In order from left to right is:
+The filters control the behavior of the Bug List.  The filters are saved between browsing sessions but do not currently save sort order or direction.  In order from left to right is:
 
 <ul>
 	<li>category
@@ -138,7 +140,9 @@ <h5>Bug List</h5>
 </blockquote>
 
 <p>
-The bug id is made into a link that leads to a more detailed report about the bug.  Depending on what you have set in your <a href="#change_preferences">Account Preferences</a> you will be sent to the simple or advanced view.  You can also <a href="#add_bugnotes">add bugnotes</a> here.
+The bug id is made into a link that leads to a more detailed report about the bug.  Depending on what you have set in your <a href="#change_preferences">Account Preferences</a> you will be sent to the simple or advanced view.  You can also <a href="#add_bugnote">add bugnotes</a> here.
+<p>
+The number in the bugnote count column will be bold if a bugnote has been added in the specified time frame.
 <p>
 The text in the "Severity" column will be bold if the severity is major, crash, or block and the bug not resolved.
 <p>
@@ -211,7 +215,7 @@ <h4><a name=view_bug_advanced>[ View Bug Advanced ]</a></h4>
 	<blockquote>
 	<h4><a name=add_vote>[ Add Vote ]</a></h4>
 	<p>
-	This increases the vote tally.  There is currently no IP spam protection for vote adding.  The idea behind the vote counter is to have duplicate reports instead increase the vote count.  As the number of reports increase the relative importance of the bug becomes clear.  This is somewhat useful in prioritizing the order in which to give attention to bugs.  NOTE: currently there is very little feedback given to developers about vote count.
+	This increases the vote tally.  There is currently no IP spam protection for vote adding.  The idea behind the vote counter is to have duplicate reports instead increase the vote count.  As the number of reports increase the relative importance of the bug becomes clear.  This is somewhat useful in prioritizing the order in which to give attention to bugs.  NOTE: currently voting is disabled while I figure out how to better utilize this feature.
 	<p>
 	</blockquote>
 <p>
@@ -231,45 +235,43 @@ <h3><a name=editing_bugs>[ Editing Bugs ]</a></h3>
 <p>
 These options are only available to Updaters, Developers, and Administrators.
 <blockquote>
-<h4><a name=delete_bug>[ Delete Bug ]</a></h4>
-<p>
-This option on the <a href="#view_bug">View Bugs</a> page allows you to delete an existing bug.  This should only be used on frivolous or test bugs.  A confirmation screen will prompt you if you really want to delete the bug.
-<p>
-
-<h4><a name=resolve_bug>[ Resolve Bug ]</a></h4>
-<p>
-This option on the <a href="#view_bug">View Bugs</a> page allows you to resolve the bug.  It will lead you to a page where you can set the resolution state and a duplicate id (if applicable).  After choosing that the user can choose to enter a bugnote detailing the reason for the closure.
-<p>
 
 <h4><a name=update_bug_simple>[ Update Bug Simple ]</a></h4>
 <p>
 Here you can update various bug fields.  The Category, Severity, and Reproducibility fields are editable but shouldn't be unless there is a gross miscategorization.
 <p>
 Also modifiable are the Assigned To, Priority, Projection, ETA, Resolution, and Duplicate ID fields.
-
 <p>
-<i>*** Suggested feature</i>: <u>force a dialog when closing a bug</u> :
-<blockquote>
-Closing a bug (setting to resolved) should check to see if the proper resolution is selected and also force the user to add a note on the closure.
-</blockquote>
 
 <p>
 <h4><a name=update_bug_advanced>[ Update Bug Advanced ]</a></h4>
 <p>
 Projection and ETA are the only current fields that are unique and modifiable to Update Bug Advanced.
 <p>
+
+<h4><a name=assign_bug>[ Assign To Me ]</a></h4>
+<p>
+If you are a developer you can use this as a one click assign to me.  This saves you 3 clicks and a page load.
+<p>
+
+
+<h4><a name=resolve_bug>[ Resolve Bug ]</a></h4>
+<p>
+This option on the <a href="#view_bug">View Bugs</a> page allows you to resolve the bug.  It will lead you to a page where you can set the resolution state and a duplicate id (if applicable).  After choosing that the user can choose to enter a bugnote detailing the reason for the closure.
+<p>
+
+
+<h4><a name=delete_bug>[ Delete Bug ]</a></h4>
+<p>
+This option on the <a href="#view_bug">View Bugs</a> page allows you to delete an existing bug.  This should only be used on frivolous or test bugs.  A confirmation screen will prompt you if you really want to delete the bug.
+<p>
 </blockquote>
 
 <!-- ---------------------------------------------------------------------- -->
 <p>
 <h3><a name=bugnotes>[ Bugnotes ]</a></h3>
 <p>
-Everyone except Viewers can add and delete bugnotes.  If the bug is closed then you cannot <a href="#add_bugnote">Add Bugnotes</a>.  You will have to <a href="#reopen_bug">Reopen Bug</a> before you can add another bugnote.
-<p>
-<i>*** Suggested feature</i>: <u>limit delete access</u> :
-<blockquote>
-Currently anyone can delete another person's bugnotes.  Only administrators should have this capability.
-</blockquote>
+Everyone except Viewers can add and delete bugnotes.  If the bug is closed then you cannot <a href="#add_bugnote">Add Bugnotes</a>.  You will have to <a href="#reopen_bug">Reopen Bug</a> before you can add another bugnote.  Only administrators and the original bugnote poster may delete the bugnote.
 <p>
 <blockquote>
 <h4><a name=add_bugnote>[ Add Bugnote ]</a></h4>
@@ -304,7 +306,7 @@ <h4><a name=report_bug_simple>[ Report Bug Simple ]</a></h4>
 <p>
 <h4><a name=report_bug_advanced>[ Report Bug Advanced ]</a></h4>
 <p>
-The advanced form has, of course, more fields to fill in than the simple version.  It has, in addition to the simple form fields, an option to choose between choosing an existing <a href="#manage_profiles">Account Profile</a> or filling in the computer platform, operating system, and operating system version/build, product version, product build, and steps to reproduce.
+The advanced form has, of course, more fields to fill in than the simple version.  It has, in addition to the simple form fields, an option to choose between choosing an existing <a href="#manage_profiles">Account Profile</a> or filling in the computer platform, operating system, and operating system version/build, product version, product build, and steps to reproduce.  You may optionally directly assign a bug to a developer.
 </blockquote>
 
 <!-- ---------------------------------------------------------------------- -->
@@ -322,10 +324,15 @@ <h3><a name=account>[ Account ]</a></h3>
 <blockquote>
 <h4><a name=manage_profiles>[ Manage Profiles ]</a></h4>
 <p>
-Here you can add new profiles.  This is useful when you don't want to keep re-entering your system configuration in the <a href="#advanced_bug_reports">Advanced Bug Reports</a>.  It allows for multiple bug reports for multiple system configurations.  There is a "Description" field for more details; however, it is currently unused.
+Here you can add new profiles.  This is useful when you don't want to keep re-entering your system configuration in the <a href="#advanced_bug_reports">Advanced Bug Reports</a>.  It allows for multiple bug reports for multiple system configurations.  There is a "Description" field as a catchall for more details
 <p>
 You can also edit, set different profiles to be defaults and delete profiles.  To reset profiles to have no default just select the blank profile and choose "Make Default".
+
 <p>
+<i>*** Suggested feature</i>: <u>User specified fields</u> :
+<blockquote>
+It would be really useful for projects to be able to tailor what their reporting needs would be.  This would also be reflected in the <a href="#advanced_bug_reports">Advanced Bug Reports</a> section.
+</blockquote>
 
 <p>
 <h4><a name=change_preferences>[ Change Preferences ]</a></h4>
@@ -340,32 +347,24 @@ <h4><a name=change_preferences>[ Change Preferences ]</a></h4>
 <p>
 <h3><a name=manage>[ Manage ]</a></h3>
 <p>
-This section is reserved exclusively for administrators.  The main Manage page shows a list of users and their relevant info.  Username, email, access level, enabled status, protected status, date created, and last visit.  From here the admin can choose to edit the user's info.
+This section is reserved exclusively for administrators.  The main Manage page shows a list of users and their relevant info.  Username, email, access level, enabled status, protected status, date created, and last visit.  From here the admin can choose to edit the user's info.  If people can signup for accounts and the admin chooses to reset the users information the user's password will be randomly generated and emailed to the user.  If users canot signup for accounts the password will be set to be blank.
 <p>
-Also available are <a href="#create_new_account">Create New Account</a>, <a href="#report_bug">Report Bug</a>, <a href="#manage_product_version">Manage Product Version</a>, and <a href="#documentation">Documentation</a>
+Also available are <a href="#create_account">Create Account</a>, <a href="#projects">Projects</a>, and <a href="#documentation">Documentation</a>
 
 <blockquote>
-<h4><a name=create_new_account>[ Create New Account ]</a></h4>
+<h4><a name=create_account>[ Create Account ]</a></h4>
 <p>
-Create a new account in this section.  Default is to have the account enabled and set to reporter.
+Create a new account in this section.  Default is to have the account enabled and set to reporter.  Currently this does *not* send an email to the user.
 
 <p>
-<i>*** Suggested feature</i>: <u>Random password generation and mailing</u> :
-<blockquote>
-Create a randomly generated password that would be mailed to the email specified.
-</blockquote>
-<p>
-
+<h4><a name=projects>[ Projects ]</a></h4>
 <p>
-<h4><a name=manage_categories>[ Manage Categories ]</a></h4>
+Projects are handled from this section.  You will see a listing of each project as well as an Add Project form at the top of the page.  You can edit the categories and versions of a project by clicking on the Edit link.  If a project is marked private it will be hidden from non-developers.  Disabled projects are hidden from all but administrators.  The status of a project can also be selected (development, release, stable, obsolete).  The description currently is only displayed in this section.
 <p>
-Here you can edit the categories.  They must be comma separated and enclosed in quotes.  You cannot have a blank entry for the categories.  If you delete a category that has been used before you will erase all bug category information in bug reports that were reported with that category (eg. if you remove 'bugtracker' then all existing bug reports that had category='bugtracker' will be blank).  They will not be affected if you merely add entries.
+In the edit project section you can update the project information, delete the project, or add versions and categories.  You can also update and delete the versions and categories.
 <p>
+Remember to add at least one category for your project!!!  Otherwise, you won't be anle to enter bug reports.
 
-<p>
-<h4><a name=manage_product_version>[ Manage Product Version ]</a></h4>
-<p>
-Manage product version works just like <a href="#manage_categories">Manage Categories</a>.  This will be selectable from the Advanced Report section.
 <p>
 <h4><a name=documentation>[ Documentation ]</a></h4>
 <p>
@@ -381,13 +380,9 @@ <h3><a name=edit_news>[ Edit News ]</a></h3>
 <p>
 Enter a headline and then the post.  Line breaks will be preserved (converted to &lt;br&gt; tags).  Do not put " in the headline.  It will be converted to a ' if you do.  This is because it screws up the Edit Post drop down list.
 <p>
-At the bottom you can either edit the selected post or delete it.  Default action, of course, is to edit the post.  You will be taken to a screen where you can edit the post.  If you choose delete then you will be taken to a page requiring confirmation.
-
+You will also select the project that the post will be posted to.  You can select a sitewide post if you wish the news item to appear on every single news page.
 <p>
-<i>*** Suggested feature</i>: <u>Force safe strings by filtering</u> :
-<blockquote>
-Put more restrictive filtering on the news.  It's unlikely that a developer of admin would purposefully screw up things but it shouldn't be allowed.
-</blockquote>
+At the bottom you can either edit the selected post or delete it.  Default action is to edit the post.  You will be taken to a screen where you can edit the post.  If you choose delete then you will be taken to a page requiring delete confirmation.
 
 <p>
 <i>*** Suggested feature</i>: <u>Allow limited HTML in news posts</u> :
@@ -417,6 +412,8 @@ <h3><a name=docs>[ Docs ]</a></h3>
 <b>ChangeLog</b>
 <p>
 
+<li>version 1.5  February 08, 2001 - Kenzaburo Ito (prescience@300baud.org)<br>
+<i>Updates for version 0.14.0</i>
 <li>version 1.0  December 12, 2000 - Kenzaburo Ito (prescience@300baud.org)<br>
 <i>Initial creation</i>