Mercurial > p > roundup > code

annotate doc/whatsnew-0.7.txt @ 2149:702f9a6afdcf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
author Richard Jones <richard@users.sourceforge.net>
date Fri, 26 Mar 2004 23:45:34 +0000
parents d9bdd08d5c5a
children cd42c3c7173a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 =========================
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 What's New in Roundup 0.7
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3 =========================
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4
2142
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
5 For those completely new to Roundup, you might want to look over the very
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
6 terse features__ page.
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
7
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
8 __ features.html
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
9
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10 .. contents::
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
11
2142
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
12 Instant-Gratification script even more gratifying
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
13 =================================================
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
14
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
15 The immensely popular ``python demo.py`` instant-gratification script has
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
16 been extended to allow you to choose the backend to use with the demo. To
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
17 select the "sqlite" backend (assuming it is available) you use::
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
18
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
19 python demo.py sqlite nuke
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
20
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
21 This will nuke any existing demo and reinitialise it with the sqlite
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
22 backend. Remember folks, if you want to restart the demo at a later point,
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
23 you just need to type::
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
24
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
25 python demo.py
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
26
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
27 without the "sqlite nuke" part, or you'll clear out the demo again. The
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
28 backend names are:
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
29
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
30 anydbm bsddb bsddb3 sqlite metakit mysql postgresql
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
31
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
32 You will need support modules installed for all except the first two. If
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
33 you're not sure whether you have support, run::
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
34
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
35 python run_tests.py
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
36
2146
7bee183f2573 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2142
diff changeset
37 and if you see a line saying "Including XXXX tests" where XXXX is the
2142
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
38 backend you wish to try, then you're on your way. The mysql and postgresql
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
39 require their test environments to be set up. Read their respective
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
40 documents in the "doc" directory to do that.
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
41
9145bf22d6f9 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2141
diff changeset
42
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
43 Web Interface
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44 =============
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
46 Saving and sharing of user queries
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
47 ----------------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
48
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
49 Due to popular demand, the user query saving mechanisms have been
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
50 overhauled.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
51
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
52 As before, you may save queries in the tracker by giving the query a
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
53 name. Each user may only have one query with a given name - if a
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
54 subsequent search is performed with the same query name supplied, then
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
55 it will edit the existing query of the same name.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
56
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
57 Queries may be marked as "private". These queries are only visible to the
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
58 user that created them. If they're not marked "private" then all other
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
59 users may include the query in their list of "Your Queries". Marking it as
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
60 private at a later date does not affect users already using the query, nor
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
61 does deleting the query.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
62
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
63 If a user subsequently creates or edits a public query, a new personal
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
64 version of that query is made, with the same editing rules as described
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
65 above.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
66
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
67 You *are not required* to make these changes in your tracker. You only
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
68 need to make them if you wish to use the new query editing features. It's
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
69 highly recommended, as the effort is minimal.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
70
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
71 1. You will need to edit your tracker's ``dbinit.py`` to change the way
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
72 queries are stored. Change the lines::
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
73
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
74 query = Class(db, "query",
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
75 klass=String(), name=String(),
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
76 url=String())
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
77 query.setkey("name")
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
78
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
79 to::
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
80
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
81 query = Class(db, "query",
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
82 klass=String(), name=String(),
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
83 url=String(), private_for=Link('user'))
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
84
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
85 That is, add the "private_for" property, and remove the line that says
2146
7bee183f2573 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2142
diff changeset
86 ``query.setkey("name")``.
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
87
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
88 2. You will also need to copy the ``query.edit.html`` template page from the
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
89 ``templates/classic/html/`` directory of the source to your tracker's
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
90 ``html`` directory.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
91
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
92 3. Once you've done that, edit the tracker's ``page.html`` template to
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
93 change::
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
94
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
95 <td rowspan="2" valign="top" class="sidebar">
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
96 <p class="classblock" tal:condition="request/user/queries">
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
97 <b>Your Queries</b><br>
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
98 <tal:block tal:repeat="qs request/user/queries">
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
99
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
100 to::
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
101
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
102 <td rowspan="2" valign="top" class="sidebar">
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
103 <p class="classblock">
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
104 <b>Your Queries</b> (<a href="query?@template=edit">edit</a>)<br>
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
105 <tal:block tal:repeat="qs request/user/queries">
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
106
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
107 That is, you're removing the ``tal:condition`` and adding a link to the
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
108 new edit page.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
109
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
110 4. You might also wish to remove the redundant query editing section from the
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
111 ``user.item.html`` page.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
112
2149
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
113 ZRoundup reinstated
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
114 -------------------
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
115
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
116 The Zope interface, ZRoundup, lives again!
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
117
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
118 See the `upgrading documentation`__ if you wish to use it.
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
119
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
120 __ upgrading.html#zroundup-changes
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
121
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
122
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
123 Simple support for collision detection
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
124 --------------------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
125
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
126 Item edit pages that use the ``context/submit`` function to generate their
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
127 submit buttons now automatically include a datestamp in the form. This
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
128 datestamp is compared to the "activity" property of the item when the form
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
129 is submitted. If the "actvity" property is younger than the datestamp in
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
130 the form submission, then someone else has edited the item, and a page
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
131 indicating this is displayed to the user.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
132
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
133
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
134 Extending the cgi interface
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
135 ---------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
136
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
137 Before 0.7.0 adding or extending web actions was done by overriding or adding
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
138 methods on the Client class. Though this approach still works to provide
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
139 backwards compatibility, it is recommended you upgrade to the new approach, as
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
140 described in the `Defining new web actions`__ section of the customization
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
141 documentation. You might also want to take a look at the `Using an external
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
142 password validation source`__ example.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
143
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
144 __ customizing.html#defining-new-web-actions
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
145 __ customizing.html#using-an-external-password-validation-source
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
146
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
147 Actions may also return the content that should return to the user, which
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
148 causes the web interface to skip the normal template formatting step.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
149 This could be used to return an image to the user instead of HTML. Be sure
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
150 to set the correct content-type header though! The default is still
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
151 text/html. This is done with::
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
152
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
153 self.client.setHeader('Content-Type', 'image/png')
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
154
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
155 if you were returning a PNG image.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
156
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
157
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
158 Added CSV export action
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
159 -----------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
160
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
161 A new action has been added which exports the current index page or search
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
162 result as a comma-separated-value (CSV) file.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
163
2146
7bee183f2573 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2142
diff changeset
164 To use it, add this to your "index" templates::
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
165
2146
7bee183f2573 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2142
diff changeset
166 <a tal:attributes="href python:request.indexargs_url('issue',
7bee183f2573 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2142
diff changeset
167 {'@action':'export_csv'})">Download as CSV</a>
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
168
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
169 Making sure that the ``'issue'`` part matches the class name of the page
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
170 you're editing.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
171
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
172 Roundup server
2141
67aea3fddce7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2139
diff changeset
173 --------------
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
174
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
175 The roundup-server web interface now supports setgid and running on port
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
176 < 1024.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
177
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
178
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
179 HTML templating made easier
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
180 ---------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
181
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
182 All HTML templating functions perform checks for permissions required to
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
183 display or edit the data they are manipulating. The simplest case is
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
184 editing an issue title. Including the expression::
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
185
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
186 context/title/field
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
187
2147
d9bdd08d5c5a *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2146
diff changeset
188 will present the user with an edit field if they have Edit Permission. If
d9bdd08d5c5a *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2146
diff changeset
189 not, then they will be presented with a static display if they have View
d9bdd08d5c5a *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2146
diff changeset
190 Permission. If they don't even have View Permission, then an error message
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
191 is raised, preventing the display of the page, indicating that they don't
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
192 have permission to view the information.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
193
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
194 This removes the need for the template to perform those checks, which was
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
195 just plain messy.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
196
2149
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
197 Some new permissions will need to be created in your trackers to cope with
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
198 this change, as outlined in the `upgrading documentation`__.
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
199
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
200 __ upgrading.html#permission-assignments
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
201
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
202
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
203 Standards changes
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
204 -----------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
205
2147
d9bdd08d5c5a *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2146
diff changeset
206 The HTTP Content-Length header when we serve up files, either
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
207 static ones from the "html" folder or file content from the database.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
208
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
209 We also handle If-Modified-Since and supply Last-Modified for both types
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
210 of file too.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
211
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
212 The HTML generated in the classic tracker is now HTML4 (or optionally
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
213 XHTML) compliant. The ``config.py`` variable "HTML_VERSION" is used to
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
214 control this behaviour.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
215
2147
d9bdd08d5c5a *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2146
diff changeset
216 The stylesheet includes printer settings now too, so printed pages
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
217 don't include the sidebar.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
218
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
219
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
220 Email Interface
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
221 ===============
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
222
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
223 Better handling of some email headers
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
224 -------------------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
225
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
226 We ignore messages with the header "Precedence: bulk".
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
227
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
228 If a Resent-From: header is present, it is used in preference to the From:
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
229 header when determining the author of the message. Useful for redirecting
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
230 error messages from automated systems.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
231
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
232
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
233 Email character set
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
234 -------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
235
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
236 The default character set for sending email is UTF-8 (ie. Unicode). If you
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
237 have users whose email clients can't handle UTF-8 (eg. Eudora) then you
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
238 will need to edit the new config.py variable ``EMAIL_CHARSET``.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
239
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
240
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
241 Dispatcher configuration
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
242 ------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
243
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
244 A new config option has been added that specifies the email address of
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
245 a "dispatcher" role. This email address acts as a central sentinel for
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
246 issues coming into the system. You can configure it so that all e-mail
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
247 error messages get bounced to them, them and the user in question, or
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
248 just the user (default).
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
249
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
250 To toggle these switches, add the "DISPATCHER_EMAIL" and
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
251 "ERROR_MESSAGES_TO" configuration values to your tracker's ``config.py``.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
252 See the `customisation documentation`_ for how to use them.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
253
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
254
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
255 More flexible message generation
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
256 --------------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
257
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
258 The code for generating email messages in Roundup has been refactored. A
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
259 new module, ``roundup.mailer`` contains most of the nuts-n-bolts required
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
260 to generate email messages from Roundup.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
261
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
262 In addition, the ``IssueClass`` methods ``nosymessage()`` and
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
263 ``send_message()`` have both been altered so that they don't require the
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
264 message id parameter. This means that change notes with no associated
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
265 change message may now be generated much more easily.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
266
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
267
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
268 Registration confirmation by email
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
269 ----------------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
270
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
271 Users may now reply to their registration confirmation email, and the
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
272 roundup mail gateway will complete their registration.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
273
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
274
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
275 Database configuration
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
276 ======================
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
277
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
278 Postgresql added as a backend option
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
279 ------------------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
280
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
281 Trackers may now use the postgresql RDBMS as a database store.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
282
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
283 Postgresql is a good choice if you expect your tracker to grow very large,
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
284 and are expecting many users.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
285
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
286
2149
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
287 API change
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
288 ----------
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
289
2149
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
290 The Database.curuserid attribute was removed. Any code referencing this
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
291 attribute should be replaced with a call to Database.getuid().
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
292
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
293
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
294 New configuration options
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
295 -------------------------
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
296
2149
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
297 - Added DEFAULT_TIMEZONE which allows the tracker to have a different
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
298 default to UTC when users don't specify their own preference.
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
299
2149
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
300 - Added EMAIL_CHARSET (in 0.6.6, but worth mentioning here) which hard-codes
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
301 the character set to be used when sending email from Roundup. This works
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
302 around some email clients' inability to cope well with UTF-8 (the
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
303 default).
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
304
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
305 - ERROR_MESSAGES_TO and DISPATCHER_EMAIL as described above in `Dispatcher
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
306 configuration`_.
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
307
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
308
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
309 Typed columns in RDBMS backends
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
310 -------------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
311
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
312 The MySQL (and Postgresql for that matter) backend now creates tables with
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
313 appropriate column datatypes (not just varchar). Sqlite got the typing
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
314 too, but it ignores the datatypes :)
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
315
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
316 Your database will be automatically migrated to use the new schemas, but
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
317 it will take time. It's probably a good idea to make sure you do this as
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
318 part of the upgrade when users are not expected to be using the system.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
319
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
320
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
321 Permission setup
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
322 ----------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
323
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
324 0.7 automatically sets up the Edit and View Permissions for all classes,
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
325 thus you don't need to do so. Feel free to remove the code::
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
326
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
327 # Add new Permissions for this schema
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
328 for cl in 'issue', 'file', 'msg', 'user', 'query', 'keyword':
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
329 db.security.addPermission(name="Edit", klass=cl,
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
330 description="User is allowed to edit "+cl)
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
331 db.security.addPermission(name="View", klass=cl,
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
332 description="User is allowed to access "+cl)
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
333
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
334 from your ``dbinit.py``.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
335
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
336
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
337 New "actor" property
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
338 --------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
339
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
340 Roundup's database has a new per-item property "actor" which reflects the
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
341 user performing the last "actvitiy". See the classic template for ways to
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
342 integrate this new property into your interface.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
343
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
344 The property will be automatically added to your existing database.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
345
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
346
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
347 New Reject exception for Auditors
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
348 ---------------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
349
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
350 An auditor may raise this exception when the current create or set
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
351 operation should be stopped.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
352
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
353 It is up to the specific interface invoking the create or set to
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
354 handle this exception sanely. For example:
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
355
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
356 - mailgw will trap and ignore Reject for file attachments and messages
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
357 - cgi will trap and present the exception in a nice format
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
358
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
359
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
360 New auditor fixes Outlook bug
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
361 -----------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
362
2139
ef727812655c *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
363 The new optional auditor ``detectors/emailauditor.py`` fires whenever a
ef727812655c *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
364 new file entity is created.
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
365
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
366 If the file is of type message/rfc822, we tack onthe extension .eml.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
367
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
368 The reason for this is that Microsoft Internet Explorer will not open
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
369 things with a .eml attachment, as they deem it 'unsafe'. Worse yet,
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
370 they'll just give you an incomprehensible error message. For more
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
371 information, please see:
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
372
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
373 http://support.microsoft.com/default.aspx?scid=kb;EN-US;825803
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
374
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
375 Their suggested work around is (excerpt):
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
376
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
377 WORKAROUND
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
378
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
379 To work around this behavior, rename the .EML file that the URL
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
380 links to so that it has a .MHT file name extension, and then update
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
381 the URL to reflect the change to the file name. To do this:
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
382
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
383 1. In Windows Explorer, locate and then select the .EML file that
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
384 the URL links.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
385 2. Right-click the .EML file, and then click Rename.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
386 3. Change the file name so that the .EML file uses a .MHT file name
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
387 extension, and then press ENTER.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
388 4. Updated the URL that links to the file to reflect the new file
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
389 name extension.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
390
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
391
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
392 New script for copying users
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
393 ----------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
394
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
395 A new script, ``scripts/copy-user.py``, will copy users from one tracker
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
396 to another. Example usage::
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
397
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
398 copy-user.py /roundup/tracker1 /roundup/tracker2 `seq 3 10` 14 16
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
399
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
400 which copies users 3, 4, 5, 6, 7, 8, 9, 10, 14 and 16.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
401
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
402
2149
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
403 Other improvements
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
404 ------------------
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
405
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
406 - All RDBMS backends now have indexes automatically created on critical
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
407 table columns.
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
408
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
409 - Additionally, the RDBMS backends also implement their own session,
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
410 one-time-key and full-text indexing stores. These were previously external
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
411 dbm stores. This change allows control of locking the database to be
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
412 completely handed over to the RDBMS.
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
413
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
414 - Date values capture fractions of seconds now. Note that the MySQL backend
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
415 is not capable of storing this precision though, so it will be lost for
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
416 users of that backend.
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
417
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
418
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
419
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
420 .. _`customisation documentation`: customizing.html
Roundup Issue Tracker: http://roundup-tracker.org/