![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/README.txt b/README.txt
index ec0037276e8ac8fd0e027726840cdad49e9ad89e..0c89029692379ad6d091ff95a7aad21f2f2deb51 100644 (file)
--- a/README.txt
+++ b/README.txt
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.
3. Usage
========
The system is designed to accessed through the command-line, e-mail or web
-interface.
+interface. Roundup has some useful doucmentation in its docstrings, so
+"pydoc roundup" will give useful information.
3.1 Command-line
----------------
3.2 E-mail
----------
See the docstring at the start of the roundup/mailgw.py source file.
+Use "pydoc roundup.mailgw".
3.3 Web
3. Design
=========
-This software was written according to the specification found at
-
- http://software-carpentry.codesourcery.com/entries/second-round/track/Roundup/
-
-a copy of the spec is distributed with roundup as doc/spec.html.
-
-
-There have been some modifications. I've marked these in the source with
-'XXX' comments when I remember to.
-
-In short:
- Class.find() - may match multiple properties, uses keyword args.
-
- Class.filter() - isn't in the spec and it's very useful to have at the Class
- level.
-
- CGI interface index view specifier layout part - lose the '+' from the
- sorting arguments (it's a reserved URL character ;). Just made no
- prefix mean ascending and '-' prefix descending.
-
- ItemClass - renamed to IssueClass to better match it only having one
- hypderdb class "issue". Allowing > 1 hyperdb class breaks the
- "superseder" multilink (since it can only link to one thing, and we'd
- want bugs to link to support and vice-versa).
-
- templates - the call="link()" is handled by special-case mechanisms in my
- top-level CGI handler. In a nutshell, the handler looks for a method on
- itself called 'index%s' or 'item%s' where %s is a class. Most items
- pass on to the templating mechanism, but the file class _always_ does
- downloading. It'll probably stay this way too...
-
- template - call="link(property)" may be used to link "the current node"
- (from an index) - the link text is the property specified.
-
- template - added functions that I found very useful: List, History and
- Submit.
-
- template - items must specify the message lists, history, etc. Having them
- by default was sometimes not wanted.
-
- template - index view determines its default columns from the template's
- <property> tags.
-
- template - menu() and field() look awfully similar now .... ;)
-
- roundup.py - the command-line tool has a lot more commands at its disposal
+See the information in the "doc" directory.
Most of the TODO items are captured in comments in the code. In summary:
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 ... :(
-roundup.py:
- . getopt() for command line
- . default init db in some way?
hyperdb:
. transaction support
+ . more efficient reverse lookups
roundupdb:
- . split the file storage into multiple files
+ . split the file storage into multiple dirs?
roundup-mailgw:
. errors as attachments
- . snip signatures?
-server:
+roundup-server:
. check the source file timestamps before reloading
-date:
- . blue Date.__sub__ needs food, badly
-config
- . default to blank config in distribution and warn appropriately
-roundup_cgi
- . searching
+cgi_client
. keep form fields in form on bad submission - only clear it if all ok
- . messages should have the roundup CGI URL in them
5. Known Bugs
date:
. date subtraction doesn't work correctly "if the dates cross leap years,
phases of the moon, ..."
-
-filter:
- . incorrectly embeds hidden fields for filters being displayed - and
- doesn't use the existing values for filters being displayed either.
+cgi:
+ . enabling a filter disables the current filter hidden fields.
6. Author
=========
-richard@bizarsoftware.com.au
+richard@users.sourceforge.net
7. Thanks