diff doc/user_guide.txt @ 1588:1ac46e7e4150

more doc work - new improved overview doc
author Richard Jones <richard@users.sourceforge.net>
date Thu, 17 Apr 2003 01:14:43 +0000
parents f5d53a939b67
children 33a0d94c7658
line wrap: on
line diff
--- a/doc/user_guide.txt	Thu Apr 17 01:14:10 2003 +0000
+++ b/doc/user_guide.txt	Thu Apr 17 01:14:43 2003 +0000
@@ -2,7 +2,7 @@
 User Guide
 ==========
 
-:Version: $Revision: 1.18 $
+:Version: $Revision: 1.19 $
 
 .. contents::
 
@@ -37,16 +37,20 @@
 and email interfaces. All three are explained below.
 
 
-Searching in your Tracker
--------------------------
+Entering values in your Tracker
+-------------------------------
 
-All interfaces to your tracker use the same format for sepcifying search
-parameters.
+All interfaces to your tracker use the same format for entering values. This
+means the web interface for entering a new issue, the web interface for
+searching issues, the email interface and even the command-line administration
+tool.
+
 
 String and Numeric properties
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-These fields just take a simple text value, like ``topic=It's broken``.
+These fields just take a simple text value, like ``It's broken``.
+
 
 Boolean properties
 ~~~~~~~~~~~~~~~~~~
@@ -54,14 +58,19 @@
 These fields take a value which indicates "yes"/"no", "true"/"false",
 "1"/"0" or "on"/"off".
 
+
 Constrained (link and multilink) properties
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Fields like "Assigned To" and "Topics" hold references to items in other
 classes ("user" and "keyword" in those two cases.)
 
-We use a comma-separated list of values to indicated which values of "user"
-or "keyword" are interesting. The values may be either numeric ids or the
+Sometimes, the selection is done through a menu, like in the "Assigned To"
+field.
+
+Where the input is not a simple menu selection, we use a comma-separated
+list of values to indicated which values of "user" or "keyword" are
+interesting. The values may be either numeric ids or the
 names of items. The special value "-1" may be used to match items where the
 property is not set. For example, the following searches on the issues:
 
@@ -199,8 +208,10 @@
 Searching Page
 --------------
 
-see `searching in your tracker`_ for an explanation of how the searching
-works.
+See `entering values in your tracker`_ for an explanation of what you may 
+type into the search form.
+
+
 
 Under the covers
 ~~~~~~~~~~~~~~~~
@@ -561,7 +572,7 @@
 command-line.
 
 Using with the shell
-~~~~~~~~~~~~~~~~~~~~
+--------------------
 
 With version 0.6.0 or newer of roundup which supports: multiple
 designators to display and the -d, -S and -s flags.

Roundup Issue Tracker: http://roundup-tracker.org/