Code

PGP support is again working (pyme API has changed significantly) and we
[roundup.git] / doc / whatsnew-0.7.txt
index 2b9c820051f4eba09210b0e5705fcc59fbc158d8..148665910f517142378acc30878f321de01442a0 100644 (file)
@@ -2,8 +2,44 @@
 What's New in Roundup 0.7
 =========================
 
+For those completely new to Roundup, you might want to look over the very
+terse features__ page.
+
+__ features.html
+
 .. contents::
 
+Instant-Gratification script even more gratifying
+=================================================
+
+The immensely popular ``python demo.py`` instant-gratification script has
+been extended to allow you to choose the backend to use with the demo. To
+select the "sqlite" backend (assuming it is available) you use::
+
+  python demo.py sqlite nuke
+
+This will nuke any existing demo and reinitialise it with the sqlite
+backend. Remember folks, if you want to restart the demo at a later point,
+you just need to type::
+
+  python demo.py
+
+without the "sqlite nuke" part, or you'll clear out the demo again. The
+backend names are:
+
+  anydbm bsddb bsddb3 sqlite metakit mysql postgresql
+
+You will need support modules installed for all except the first two. If
+you're not sure whether you have support, run::
+
+  python run_tests.py
+
+and if you see a line saying "Including XXXX tests" where XXXX is the
+backend you wish to try, then you're on your way. The mysql and postgresql
+require their test environments to be set up. Read their respective
+documents in the "doc" directory to do that.
+
+
 Web Interface
 =============
 
@@ -47,7 +83,7 @@ highly recommended, as the effort is minimal.
                       url=String(),       private_for=Link('user'))
 
    That is, add the "private_for" property, and remove the line that says
-   ``query.setkey("name")``. The latter is the most important edit here.
+   ``query.setkey("name")``.
 
 2. You will also need to copy the ``query.edit.html`` template page from the
    ``templates/classic/html/`` directory of the source to your tracker's
@@ -74,6 +110,15 @@ highly recommended, as the effort is minimal.
 4. You might also wish to remove the redundant query editing section from the
    ``user.item.html`` page.
 
+ZRoundup reinstated
+-------------------
+
+The Zope interface, ZRoundup, lives again!
+
+See the `upgrading documentation`__ if you wish to use it.
+
+__ upgrading.html#zroundup-changes
+
 
 Simple support for collision detection
 --------------------------------------
@@ -110,26 +155,16 @@ text/html. This is done with::
 if you were returning a PNG image.
 
 
-Added CSV export action
------------------------
-
-A new action has been added which exports the current index page or search
-result as a comma-separated-value (CSV) file.
-
-To use it, add this to your "index" templates:
-
-<a tal:attributes="href python:request.indexargs_url('issue',
-            {'@action':'csv_export'})">Download as CSV</a>
-
-Making sure that the ``'issue'`` part matches the class name of the page
-you're editing.
-
 Roundup server 
 --------------
 
 The roundup-server web interface now supports setgid and running on port
 < 1024.
 
+It also forks to handle new connections, which means that trackers using
+the postgresql or mysql backends will be able to have multiple users
+accessing the tracker simultaneously.
+
 
 HTML templating made easier
 ---------------------------
@@ -140,20 +175,25 @@ editing an issue title. Including the expression::
 
    context/title/field
 
-Will present the user with an edit field, if they have edit permission. If
-not, then they will be presented with a static display if they have view
-permission. If they don't even have view permission, then an error message
+will present the user with an edit field if they have Edit Permission. If
+not, then they will be presented with a static display if they have View
+Permission. If they don't even have View Permission, then an error message
 is raised, preventing the display of the page, indicating that they don't
 have permission to view the information.
 
 This removes the need for the template to perform those checks, which was
 just plain messy.
 
+Some new permissions will need to be created in your trackers to cope with
+this change, as outlined in the `upgrading documentation`__.
+
+__ upgrading.html#permission-assignments
+
 
 Standards changes
 -----------------
 
-We now set the HTTP Content-Length header when we serve up files, either
+The HTTP Content-Length header when we serve up files, either
 static ones from the "html" folder or file content from the database.
 
 We also handle If-Modified-Since and supply Last-Modified for both types
@@ -163,10 +203,58 @@ The HTML generated in the classic tracker is now HTML4 (or optionally
 XHTML) compliant. The ``config.py`` variable "HTML_VERSION" is used to
 control this behaviour.
 
-We've got a printer setting in the stylesheet now too, so printed pages
+The stylesheet includes printer settings now too, so printed pages
 don't include the sidebar.
 
 
+Quoting of URLs and HTML
+------------------------
+
+Templates that wish to offer file downloads may now use a new
+``download_url`` method::
+
+ <tr tal:repeat="file context/files">
+  <td>
+   <a tal:attributes="href file/download_url"
+      tal:content="file/name">dld link</a>
+  </td>
+ ...
+
+The ``download_url`` method looks up the file's "id" and "name" and
+generates a correctly-quoted URL.
+
+Additionally, users wishing to URL- or HTML- quote text in their templates
+may use the new ``utils.url_quote(url)`` and ``utils.html_quote(html)``
+methods.
+
+
+CSV download of search results
+------------------------------
+
+A new CGI action, ``export_csv`` has been added which exports a given
+index page query as a comma-separated-value file.
+
+To use this new action, just add a link to your ``issue.index.html``
+page::
+
+  <a tal:attributes="href python:request.indexargs_url('issue',
+            {'@action':'export_csv'})">Download as CSV</a>
+
+You may use this for other classes by adding it to their index page and
+changing the ``'issue'`` part of the expression to the new class' name.
+
+
+Other changes
+-------------
+
+- we serve up a favicon now
+- the page titles have the tracker name at the end of the text instead
+  of the start
+- added url_quote and html_quote methods to the utils object
+- added isset method to HTMLProperty
+- added search_checkboxes as an option for the search form
+
+
 Email Interface
 ===============
 
@@ -214,6 +302,10 @@ In addition, the ``IssueClass`` methods ``nosymessage()`` and
 message id parameter. This means that change notes with no associated
 change message may now be generated much more easily.
 
+The roundupdb nosymessage() method also accepts a ``bcc`` argument which
+specifies additional userids to send the message to that will not be
+included in the To: header of the message.
+
 
 Registration confirmation by email
 ----------------------------------
@@ -222,6 +314,23 @@ Users may now reply to their registration confirmation email, and the
 roundup mail gateway will complete their registration.
 
 
+``roundup-mailgw`` now supports IMAP
+------------------------------------
+
+To retrieve from an IMAP mailbox, use a *cron* entry similar to the
+POP one::
+
+  0,10,20,30,40,50 * * * * /usr/local/bin/roundup-mailgw /opt/roundup/trackers/support imap <imap_spec>
+
+where imap_spec is "``username:password@server``" that specifies the roundup
+submission user's IMAP account name, password and server. You may
+optionally include a mailbox to use other than the default ``INBOX`` with
+"``imap username:password@server mailbox``".
+
+If you have a secure (ie. HTTPS) IMAP server then you may use ``imaps``
+in place of ``imap`` in the command to use a secure connection.
+
+
 Database configuration
 ======================
 
@@ -234,28 +343,33 @@ Postgresql is a good choice if you expect your tracker to grow very large,
 and are expecting many users.
 
 
-Other improvements
-------------------
+API change
+----------
 
-All RDBMS backends now have indexes automatically created on critical
-table columns.
+The Database.curuserid attribute was removed. Any code referencing this
+attribute should be replaced with a call to Database.getuid().
 
-Additionally, the RDBMS backends also implement their own session,
-one-time-key and full-text indexing stores. These were previously external
-dbm stores. This change allows control of locking the database to be
-completely handed over to the RDBMS.
 
-Date values capture fractions of seconds now. Note that the MySQL backend
-is not capable of storing this precision though, so it will be lost for
-users of that backend.
+New configuration options
+-------------------------
+
+- Added DEFAULT_TIMEZONE which allows the tracker to have a different
+  default to UTC when users don't specify their own preference.
+
+- Added EMAIL_CHARSET (in 0.6.6, but worth mentioning here) which hard-codes
+  the character set to be used when sending email from Roundup. This works
+  around some email clients' inability to cope well with UTF-8 (the
+  default).
+
+- ERROR_MESSAGES_TO and DISPATCHER_EMAIL as described above in `Dispatcher
+  configuration`_.
 
 
 Typed columns in RDBMS backends
 -------------------------------
 
-The MySQL (and Postgresql for that matter) backend now creates tables with
-appropriate column datatypes (not just varchar). Sqlite got the typing
-too, but it ignores the datatypes :)
+The SQLite, MySQL and Postgresql backends now create tables with
+appropriate column datatypes (not just varchar).
 
 Your database will be automatically migrated to use the new schemas, but
 it will take time. It's probably a good idea to make sure you do this as
@@ -307,7 +421,7 @@ New auditor fixes Outlook bug
 The new optional auditor ``detectors/emailauditor.py`` fires whenever a
 new file entity is created.
 
-If the file is of type message/rfc822, we tack onthe extension .eml.
+If the file is of type message/rfc822, we tack on the extension .mht.
 
 The reason for this is that Microsoft Internet Explorer will not open
 things with a .eml attachment, as they deem it 'unsafe'. Worse yet,
@@ -344,4 +458,24 @@ to another.  Example usage::
 which copies users 3, 4, 5, 6, 7, 8, 9, 10, 14 and 16.
 
 
+Other improvements
+------------------
+
+- All RDBMS backends now have indexes automatically created on critical
+  table columns.
+
+- Additionally, the RDBMS backends also implement their own session,
+  one-time-key and full-text indexing stores. These were previously external
+  dbm stores. This change allows control of locking the database to be
+  completely handed over to the RDBMS.
+
+- Date values capture fractions of seconds now. Note that the MySQL backend
+  is not capable of storing this precision though, so it will be lost for
+  users of that backend.
+
+- The roundup-admin "export" and "import" commands now handle the database
+  journals too. This means that exports from previous versions of Roundup
+  will not work under 0.7!
+
+
 .. _`customisation documentation`: customizing.html