Code

Minor change
[roundup.git] / README.txt
index cd824188f2809b6af4b0c7ff18a7838e7416a6aa..02f18a99420987cbd357ac3986e091302cee89d4 100644 (file)
@@ -4,8 +4,23 @@
 
 1. License
 ==========
-This software is released under the GNU GPL. The copyright is held by Bizar
-Software Pty Ltd (http://www.bizarsoftware.com.au).
+
+Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
+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.
+
+IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
+DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
+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
+FOR A PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
+BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
+SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+
 
 The stylesheet included with this package has been copied from the Zope
 management interface and presumably belongs to Digital Creations.
@@ -18,41 +33,7 @@ For installation notes, please see the file INSTALL.TXT
 
 3. Usage
 ========
-The system is designed to accessed through the command-line, e-mail or web
-interface.
-
-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.
-
-
-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
@@ -69,7 +50,6 @@ in general:
   . 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
@@ -77,15 +57,11 @@ roundupdb:
   . split the file storage into multiple dirs?
 roundup-mailgw:
   . errors as attachments
-  . snip signatures?
+  . limits on the e-mail addresses that may use the mail gateway
 roundup-server:
   . check the source file timestamps before reloading
 cgi_client
   . keep form fields in form on bad submission - only clear it if all ok
-  . e-mail messages should have the roundup CGI URL in them
-roundup.cgi
-  . make it detect that it is in an instance_home and just use that
-    instance by default?
 
 
 5. Known Bugs
@@ -94,11 +70,13 @@ roundup.cgi
 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
 =========
-richard@sourceforge.net
+richard@users.sourceforge.net
 
 
 7. Thanks