fixes and release announcement

[roundup.git] / doc / user_guide.txt

diff --git a/doc/user_guide.txt b/doc/user_guide.txt
index 8925326f7adba75f580ac082c7d0fe2442a5fe25..474dcdc222e931fbeed880977d934f5c5213a53a 100644 (file)
--- a/doc/user_guide.txt
+++ b/doc/user_guide.txt
@@ -2,7 +2,7 @@
 User Guide
 ==========
 
-:Version: $Revision: 1.23 $
+:Version: $Revision: 1.27 $
 
 .. contents::
 
@@ -27,6 +27,11 @@ incidentally, is *always* the "admin" user) is referred to as "user1".
 Issue number 315 is referred to as "issue315". We call that label the
 item's *designator*.
 
+Items in the database are never deleted, they're just "retired". You
+can still refer to them by ID - hence removing an item won't break
+references to the item. It's just that the item won't appear in any
+listings.
+
 
 Accessing the Tracker
 ---------------------
@@ -171,6 +176,14 @@ XXX explain...
 When searching on interval properties use the same syntax as for dates.
 
 
+Simple support for collision detection
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Item edit pages remember when the item was last edited. When a form is
+submitted, the user will be informed if someone else has edited the item
+at the same time they tried to.
+
+
 Web Interface
 =============
 
@@ -240,6 +253,24 @@ See `entering values in your tracker`_ for an explanation of what you
 may type into the search form.
 
 
+Saving queries
+~~~~~~~~~~~~~~
+
+You may save queries in the tracker by giving the query a name. Each user
+may only have one query with a given name - if a subsequent search is
+performed with the same query name supplied, then it will edit the
+existing query of the same name.
+
+Queries may be marked as "private". These queries are only visible to the
+user that created them. If they're not marked "private" then all other
+users may include the query in their list of "Your Queries". Marking it as
+private at a later date does not affect users already using the query, nor
+does deleting the query.
+
+If a user subsequently creates or edits a public query, a new personal
+version of that query is made, with the same editing rules as described
+above.
+
 
 Under the covers
 ~~~~~~~~~~~~~~~~
@@ -473,6 +504,10 @@ is queried to determine if they get a nosy list copy of the message too.
 Mail gateway script command line
 --------------------------------
 
+Usage::
+
+  roundup-mailgw [[-C class] -S field=value]* <instance home> [method]
+
 The roundup mail gateway may be called in one of three ways:
 
  - with an instance home as the only argument,
@@ -590,13 +625,13 @@ arguments and in the printed results:
   explained below.::
   
     Input of...        Means...
-    "2000-04-17.03:45" 2000-04-17.08:45:00
+    "2000-04-17.03:45" 2000-04-17.03:45:00
     "2000-04-17"       2000-04-17.00:00:00
     "01-25"            yyyy-01-25.00:00:00
-    "08-13.22:13"      yyyy-08-14.03:13:00
-    "11-07.09:32:43"   yyyy-11-07.14:32:43
-    "14:25"            yyyy-mm-dd.19:25:00
-    "8:47:11"          yyyy-mm-dd.13:47:11
+    "08-13.22:13"      yyyy-08-13.22:13:00
+    "11-07.09:32:43"   yyyy-11-07.09:32:43
+    "14:25"            yyyy-mm-dd.14:25:00
+    "8:47:11"          yyyy-mm-dd.08:47:11
     "2003"             2003-01-01.00:00:00
     "2003-04"          2003-04-01.00:00:00
     "."                "right now"