Code

- add a small word-splitting test for the indexers when answering an
[roundup.git] / doc / features.txt
index 5609db66c0644039f3c75ad812f0bf6561fa9145..e1fa98eef211cc0558041db7c496bf3419e3b141 100644 (file)
@@ -8,20 +8,25 @@ from Ka-Ping Yee in the Software Carpentry "Track" design competition.
 
 *simple to install*
  - installation (including web interface) takes about 30 minutes
+ - instant-gratification ``python demo.py`` :)
  - two templates included in the distribution for you to base your tracker on
- - doesn't need *any* additional support software - python (2.1+) is enough to
-   get you going
- - easy to set up higher-performance storage backends like sqlite_ and
-   metakit_
- - the really impatient can try the instant-gratification Demo Mode (``python
-   demo.py``)
+ - play with the demo, customise it and then use *it* as the template for
+   your production tracker
+ - requires *no* additional support software - python (2.3+ but not 3+) is
+   enough to get you going
+ - easy to set up higher-performance storage backends like sqlite_,
+   mysql_ and postgresql_
 
 *simple to use*
  - accessible through the web, email, command-line or Python programs
  - may be used to track bugs, features, user feedback, sales opportunities,
    milestones, ...
- - keeps a full history of changes to issues with configurable verbosity
+ - automatically keeps a full history of changes to issues with
+   configurable verbosity and easy access to information about who created
+   or last modified *any* item in the database
  - issues have their own mini mailing list (nosy list)
+ - users may sign themselves up, there may be automatic signup for
+   incoming email and users may handle their own password reset requests
 
 *highly configurable*
  - web interface HTML is fully editable
@@ -29,15 +34,20 @@ from Ka-Ping Yee in the Software Carpentry "Track" design competition.
    with a full set of data types (including dates and many-to-many relations)
    across all storages available
  - customised automatic auditors and reactors may be written that perform
-   actions before and after changes are made to entries in the database
- - samples are provided for all types of configuration changes
+   actions before and after changes are made to entries in the database,
+   or may veto the creation or modification of items in the database
+ - samples are provided for all manner of configuration changes and
+   customisations
 
 *fast, scalable*
- - with the sqlite_, metakit_ and mysql backends, roundup is also fast and
-   scalable, easily handling thousands of issues and users with decent
-   response times
+ - with the sqlite, mysql and postgresql backends, roundup is
+   also fast and scalable, easily handling thousands of issues and users
+   with decent response times
+ - database indexes are automatically added for those backends that
+   support them (sqlite, mysql and postgresql)
  - indexed text searching giving fast responses to searches across all
    messages and indexed string properties
+ - support for the Xapian full-text indexing engine for large trackers
 
 *documented*
  - documentation exists for installation, upgrading, maintenance, users and
@@ -51,8 +61,8 @@ from Ka-Ping Yee in the Software Carpentry "Track" design competition.
    to register new users
  - authentication of user registration and user-driven password resetting
    using email and one time keys
- - may be run through CGI as a normal cgi script, as a stand-alone
-   web server, or through Zope
+ - may be run using WSGI or through CGI as a normal cgi script, as a
+   stand-alone web server, under mod_python or through Zope
  - searching may be performed using many constraints, including a full-text
    search of messages attached to issues
  - file attachments (added through the web or email) are served up with the
@@ -60,6 +70,12 @@ from Ka-Ping Yee in the Software Carpentry "Track" design competition.
  - email change messages generated by roundup appear to be sent by the
    person who made the change, but responses will go back through the nosy
    list by default
+ - flexible access control built around Permissions and Roles with assigned
+   Permissions
+ - generates valid HTML4 or XHTML
+ - detects concurrent user changes
+ - saving and editing of user-defined queries which may optionally be
+   shared with other users
 
 *e-mail interface*
  - may be set up using sendmail-like delivery alias, POP polling or mailbox
@@ -86,6 +102,12 @@ from Ka-Ping Yee in the Software Carpentry "Track" design competition.
  - a variety of sample shell scripts are provided (weekly reports, issue
    generation, ...)
 
+*xmlrpc interface*
+ - simple remote tracker interface with basic HTTP authentication
+ - provides same access to tracker as roundup-admin, but based on
+   XMLRPC calls
+
 .. _sqlite: http://www.hwaci.com/sw/sqlite/
-.. _metakit: http://www.equi4.com/metakit/
+.. _mysql: http://sourceforge.net/projects/mysql-python
+.. _postgresql: http://initd.org/software/initd/psycopg