Mercurial > p > roundup > code

annotate doc/whatsnew-0.7.txt @ 2146:7bee183f2573

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
*** empty log message ***
author Richard Jones <richard@users.sourceforge.net>
date Fri, 26 Mar 2004 07:53:52 +0000
parents 9145bf22d6f9
children d9bdd08d5c5a
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
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
113
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
114 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
115 --------------------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
116
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
117 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
118 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
119 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
120 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
121 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
122 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
123
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 Extending the cgi interface
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
126 ---------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
127
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
128 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
129 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
130 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
131 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
132 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
133 password validation source`__ example.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
134
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
135 __ 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
136 __ 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
137
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
138 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
139 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
140 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
141 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
142 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
143
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
144 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
145
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
146 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
147
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
148
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
149 Added CSV export action
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
150 -----------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
151
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
152 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
153 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
154
2146
7bee183f2573 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2142
diff changeset
155 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
156
2146
7bee183f2573 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2142
diff changeset
157 <a tal:attributes="href python:request.indexargs_url('issue',
7bee183f2573 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2142
diff changeset
158 {'@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
159
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
160 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
161 you're editing.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
162
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
163 Roundup server
2141
67aea3fddce7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2139
diff changeset
164 --------------
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
165
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
166 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
167 < 1024.
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
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
170 HTML templating made easier
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
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
173 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
174 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
175 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
176
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
177 context/title/field
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 Will present the user with an edit field, if they have edit permission. If
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
180 not, then they will be presented with a static display if they have view
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
181 permission. If they don't even have view permission, then an error message
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
182 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
183 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
184
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
185 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
186 just plain messy.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
187
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
188
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
189 Standards changes
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
190 -----------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
191
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
192 We now set the HTTP Content-Length header when we serve up files, either
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
193 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
194
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
195 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
196 of file too.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
197
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
198 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
199 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
200 control this behaviour.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
201
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
202 We've got a printer setting in the stylesheet now too, so printed pages
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
203 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
204
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
205
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
206 Email Interface
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
207 ===============
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 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
210 -------------------------------------
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 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
213
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
214 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
215 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
216 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
217
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 Email character set
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
220 -------------------
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 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
223 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
224 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
225
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
226
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
227 Dispatcher configuration
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
228 ------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
229
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
230 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
231 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
232 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
233 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
234 just the user (default).
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 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
237 "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
238 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
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 More flexible message generation
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 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
245 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
246 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
247
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
248 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
249 ``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
250 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
251 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
252
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 Registration confirmation by email
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
255 ----------------------------------
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 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
258 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
259
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
260
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
261 Database configuration
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
262 ======================
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
263
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
264 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
265 ------------------------------------
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 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
268
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
269 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
270 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
271
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
272
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
273 Other improvements
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
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
276 All RDBMS backends now have indexes automatically created on critical
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
277 table columns.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
278
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
279 Additionally, the RDBMS backends also implement their own session,
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
280 one-time-key and full-text indexing stores. These were previously external
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
281 dbm stores. This change allows control of locking the database to be
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
282 completely handed over to the RDBMS.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
283
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
284 Date values capture fractions of seconds now. Note that the MySQL backend
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
285 is not capable of storing this precision though, so it will be lost for
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
286 users of that backend.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
287
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
288
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
289 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
290 -------------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
291
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
292 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
293 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
294 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
295
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
296 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
297 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
298 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
299
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
300
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
301 Permission setup
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
302 ----------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
303
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
304 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
305 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
306
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
307 # 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
308 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
309 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
310 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
311 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
312 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
313
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
314 from your ``dbinit.py``.
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
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
317 New "actor" property
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
318 --------------------
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 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
321 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
322 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
323
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
324 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
325
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 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
328 ---------------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
329
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
330 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
331 operation should be stopped.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
332
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
333 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
334 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
335
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
336 - 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
337 - 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
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 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
341 -----------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
342
2139
ef727812655c *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
343 The new optional auditor ``detectors/emailauditor.py`` fires whenever a
ef727812655c *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
344 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
345
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
346 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
347
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
348 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
349 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
350 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
351 information, please see:
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 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
354
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
355 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
356
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
357 WORKAROUND
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 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
360 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
361 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
362
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
363 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
364 the URL links.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
365 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
366 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
367 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
368 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
369 name extension.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
370
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
371
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
372 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
373 ----------------------------
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 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
376 to another. Example usage::
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
377
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
378 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
379
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
380 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
381
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 .. _`customisation documentation`: customizing.html
Roundup Issue Tracker: http://roundup-tracker.org/