1 Roundup
2 =======
5 1. License
6 ==========
7 This software is released under the GNU GPL. The copyright is held by Bizar
8 Software Pty Ltd (http://www.bizarsoftware.com.au).
10 The stylesheet included with this package has been copied from the Zope
11 management interface and presumably belongs to Digital Creations.
14 2. Installation
15 ===============
16 For installation notes, please see the file INSTALL.TXT
19 3. Usage
20 ========
21 The system is designed to accessed through the command-line, e-mail or web
22 interface.
24 3.1 Command-line
25 ----------------
26 The command-line tool is called "roundup-admin" and is used for most low-level
27 database manipulations such as:
28 . creating a database instance
29 . redefining the list of products ("create" and "retire" commands)
30 . adding users manually, or setting their passwords ("create" and "set")
31 . other stuff - run it with no arguments to get a better description of
32 what it does.
35 3.2 E-mail
36 ----------
37 See the docstring at the start of the roundup/mailgw.py source file.
40 3.3 Web
41 -------
42 Hopefully, this interface is pretty self-explanatory...
44 Index views may be modified by the following arguments:
45 :sort - sort by prop name, optionally preceeded with '-'
46 to give descending or nothing for ascending sorting.
47 :group - group by prop name, optionally preceeded with '-' or
48 to sort in descending or nothing for ascending order.
49 :filter - selects which props should be displayed in the filter
50 section. Default is all.
51 :columns - selects the columns that should be displayed.
52 Default is all.
53 propname - selects the values the node properties given by propname
54 must have (very basic search/filter).
58 3. Design
59 =========
60 See the information in the "doc" directory.
64 4. TODO
65 =======
66 Most of the TODO items are captured in comments in the code. In summary:
68 in general:
69 . more unit tests
70 . more back-ends
71 . better error handling (nicer messages for users)
72 . possibly revert the entire damn thing to 1.5.2 ... :(
73 hyperdb:
74 . transaction support
75 . more efficient reverse lookups
76 roundupdb:
77 . split the file storage into multiple dirs?
78 roundup-mailgw:
79 . errors as attachments
80 . snip signatures?
81 roundup-server:
82 . check the source file timestamps before reloading
83 cgi_client
84 . keep form fields in form on bad submission - only clear it if all ok
85 . e-mail messages should have the roundup CGI URL in them
88 5. Known Bugs
89 =============
91 date:
92 . date subtraction doesn't work correctly "if the dates cross leap years,
93 phases of the moon, ..."
95 cgi_client
96 . user creation result form has a lot of [field with no item] entries..
99 6. Author
100 =========
101 richard@sourceforge.net
104 7. Thanks
105 =========
106 Well, Ping, of course ;)
108 Anthony Baxter, for some good first-release feedback. And then continuing
109 support through development on sourceforge.