Code

Fixed bugs:
[roundup.git] / README.txt
index ae770050f2b2adff60f6f73ffb02eb29ba00be0c..02f18a99420987cbd357ac3986e091302cee89d4 100644 (file)
@@ -10,10 +10,10 @@ This module is free software, and you may redistribute it and/or modify
 under the same terms as Python, so long as this copyright message and
 disclaimer are retained in their original form.
 
 under the same terms as Python, so long as this copyright message and
 disclaimer are retained in their original form.
 
-IN NO EVENT SHALL THE BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
+IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
 DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
 DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
-OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGE.
+OUT OF THE USE OF THIS CODE, EVEN IF BIZAR SOFTWARE PTY LTD HAS BEEN ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGE.
 
 BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 
 BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
@@ -33,43 +33,7 @@ For installation notes, please see the file INSTALL.TXT
 
 3. Usage
 ========
 
 3. Usage
 ========
-The system is designed to accessed through the command-line, e-mail or web
-interface. Roundup has some useful doucmentation in its docstrings, so
-"pydoc roundup" will give useful information.
-
-3.1 Command-line
-----------------
-The command-line tool is called "roundup-admin" and is used for most low-level
-database manipulations such as:
- . creating a database instance
- . redefining the list of products ("create" and "retire" commands)
- . adding users manually, or setting their passwords ("create" and "set")
- . other stuff - run it with no arguments to get a better description of
-   what it does.
-
-
-3.2 E-mail
-----------
-See the docstring at the start of the roundup/mailgw.py source file.
-Use "pydoc roundup.mailgw".
-
-
-3.3 Web
--------
-Hopefully, this interface is pretty self-explanatory...
-
-Index views may be modified by the following arguments:
-    :sort    - sort by prop name, optionally preceeded with '-'
-            to give descending or nothing for ascending sorting.
-    :group   - group by prop name, optionally preceeded with '-' or
-            to sort in descending or nothing for ascending order.
-    :filter  - selects which props should be displayed in the filter
-            section. Default is all.
-    :columns - selects the columns that should be displayed.
-            Default is all.
-    propname - selects the values the node properties given by propname
-             must have (very basic search/filter).
-
+See the index.html file in the "doc" directory.
 
 
 3. Design
 
 
 3. Design
@@ -86,7 +50,6 @@ in general:
   . more unit tests
   . more back-ends
   . better error handling (nicer messages for users)
   . more unit tests
   . more back-ends
   . better error handling (nicer messages for users)
-  . possibly revert the entire damn thing to 1.5.2 ... :(
 hyperdb:
   . transaction support
   . more efficient reverse lookups
 hyperdb:
   . transaction support
   . more efficient reverse lookups
@@ -94,6 +57,7 @@ roundupdb:
   . split the file storage into multiple dirs?
 roundup-mailgw:
   . errors as attachments
   . split the file storage into multiple dirs?
 roundup-mailgw:
   . errors as attachments
+  . limits on the e-mail addresses that may use the mail gateway
 roundup-server:
   . check the source file timestamps before reloading
 cgi_client
 roundup-server:
   . check the source file timestamps before reloading
 cgi_client
@@ -106,6 +70,8 @@ cgi_client
 date:
   . date subtraction doesn't work correctly "if the dates cross leap years,
     phases of the moon, ..."
 date:
   . date subtraction doesn't work correctly "if the dates cross leap years,
     phases of the moon, ..."
+cgi:
+  . enabling a filter disables the current filter hidden fields.
 
 
 6. Author
 
 
 6. Author