Mercurial > p > roundup > code

annotate doc/whatsnew-0.7.txt @ 5695:3e1b66c4e1e2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update docs. Correct errors reported by setup.py build_docs. Add rest interface and link to rest doc to features page. Add link to xmlrpc doc to features page. Add rest doc to index. Update rest doc, hopefully clarify confusing use of parameters in patch action section. Fix code examples in "Adding new rest endpoints" section. Fix example adding import of exception.
author John Rouillard <rouilj@ieee.org>
date Sun, 07 Apr 2019 20:17:52 -0400
parents 9b447ac40be3
children 692242b3effd
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 Roundup server
2141
67aea3fddce7 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2139
diff changeset
159 --------------
2138
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 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
162 < 1024.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
163
2219
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
164 It also forks to handle new connections, which means that trackers using
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
165 the postgresql or mysql backends will be able to have multiple users
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
166 accessing the tracker simultaneously.
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
167
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 HTML templating made easier
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
170 ---------------------------
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 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
173 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
174 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
175
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
176 context/title/field
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
177
2147
d9bdd08d5c5a *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2146
diff changeset
178 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
179 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
180 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
181 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
182 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
183
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
184 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
185 just plain messy.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
186
2149
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
187 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
188 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
189
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
190 __ 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
191
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
192
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
193 Standards changes
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
2147
d9bdd08d5c5a *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2146
diff changeset
196 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
197 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
198
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
199 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
200 of file too.
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 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
203 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
204 control this behaviour.
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 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
207 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
208
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
209
2180
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2166
diff changeset
210 Quoting of URLs and HTML
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2166
diff changeset
211 ------------------------
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2166
diff changeset
212
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2166
diff changeset
213 Templates that wish to offer file downloads may now use a new
2223
9b447ac40be3 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2219
diff changeset
214 ``download_url`` method::
2180
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2166
diff changeset
215
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2166
diff changeset
216 <tr tal:repeat="file context/files">
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2166
diff changeset
217 <td>
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2166
diff changeset
218 <a tal:attributes="href file/download_url"
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2166
diff changeset
219 tal:content="file/name">dld link</a>
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2166
diff changeset
220 </td>
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2166
diff changeset
221 ...
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2166
diff changeset
222
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2166
diff changeset
223 The ``download_url`` method looks up the file's "id" and "name" and
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2166
diff changeset
224 generates a correctly-quoted URL.
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2166
diff changeset
225
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2166
diff changeset
226 Additionally, users wishing to URL- or HTML- quote text in their templates
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2166
diff changeset
227 may use the new ``utils.url_quote(url)`` and ``utils.html_quote(html)``
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2166
diff changeset
228 methods.
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2166
diff changeset
229
58b6d1747973 Web interface tweaks.
Richard Jones <richard@users.sourceforge.net>
parents: 2166
diff changeset
230
2219
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
231 CSV download of search results
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
232 ------------------------------
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
233
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
234 A new CGI action, ``export_csv`` has been added which exports a given
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
235 index page query as a comma-separated-value file.
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
236
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
237 To use this new action, just add a link to your ``issue.index.html``
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
238 page::
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
239
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
240 <a tal:attributes="href python:request.indexargs_url('issue',
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
241 {'@action':'export_csv'})">Download as CSV</a>
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
242
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
243 You may use this for other classes by adding it to their index page and
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
244 changing the ``'issue'`` part of the expression to the new class' name.
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
245
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
246
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
247 Other changes
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
248 -------------
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
249
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
250 - we serve up a favicon now
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
251 - the page titles have the tracker name at the end of the text instead
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
252 of the start
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
253 - added url_quote and html_quote methods to the utils object
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
254 - added isset method to HTMLProperty
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
255 - added search_checkboxes as an option for the search form
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
256
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
257
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
258 Email Interface
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 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
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 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
265
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
266 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
267 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
268 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
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 Email character set
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
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
274 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
275 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
276 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
277
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 Dispatcher configuration
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
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
282 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
283 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
284 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
285 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
286 just the user (default).
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 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
289 "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
290 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
291
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
292
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
293 More flexible message generation
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
294 --------------------------------
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 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
297 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
298 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
299
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
300 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
301 ``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
302 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
303 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
304
2219
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
305 The roundupdb nosymessage() method also accepts a ``bcc`` argument which
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
306 specifies additional userids to send the message to that will not be
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
307 included in the To: header of the message.
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
308
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
309
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
310 Registration confirmation by email
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
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
313 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
314 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
315
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
316
2219
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
317 ``roundup-mailgw`` now supports IMAP
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
318 ------------------------------------
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
319
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
320 To retrieve from an IMAP mailbox, use a *cron* entry similar to the
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
321 POP one::
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
322
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
323 0,10,20,30,40,50 * * * * /usr/local/bin/roundup-mailgw /opt/roundup/trackers/support imap <imap_spec>
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
324
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
325 where imap_spec is "``username:password@server``" that specifies the roundup
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
326 submission user's IMAP account name, password and server. You may
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
327 optionally include a mailbox to use other than the default ``INBOX`` with
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
328 "``imap username:password@server mailbox``".
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
329
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
330 If you have a secure (ie. HTTPS) IMAP server then you may use ``imaps``
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
331 in place of ``imap`` in the command to use a secure connection.
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
332
2623b1afc2b6 pre-b3 stuff
Richard Jones <richard@users.sourceforge.net>
parents: 2182
diff changeset
333
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
334 Database configuration
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 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
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 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
341
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
342 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
343 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
344
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
345
2149
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
346 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
347 ----------
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
348
2149
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
349 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
350 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
351
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
352
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
353 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
354 -------------------------
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
355
2149
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
356 - 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
357 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
358
2149
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
359 - 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
360 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
361 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
362 default).
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
363
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
364 - 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
365 configuration`_.
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
366
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 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
369 -------------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
370
2166
cd42c3c7173a MySQL and Postgresql use BOOL/BOOLEAN for Boolean types
Richard Jones <richard@users.sourceforge.net>
parents: 2149
diff changeset
371 The SQLite, MySQL and Postgresql backends now create tables with
cd42c3c7173a MySQL and Postgresql use BOOL/BOOLEAN for Boolean types
Richard Jones <richard@users.sourceforge.net>
parents: 2149
diff changeset
372 appropriate column datatypes (not just varchar).
2138
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 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
375 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
376 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
377
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 Permission setup
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
380 ----------------
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 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
383 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
384
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
385 # 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
386 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
387 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
388 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
389 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
390 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
391
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
392 from your ``dbinit.py``.
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 New "actor" property
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
396 --------------------
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 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
399 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
400 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
401
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
402 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
403
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
404
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
405 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
406 ---------------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
407
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
408 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
409 operation should be stopped.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
410
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
411 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
412 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
413
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
414 - 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
415 - 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
416
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
417
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
418 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
419 -----------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
420
2139
ef727812655c *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
421 The new optional auditor ``detectors/emailauditor.py`` fires whenever a
ef727812655c *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2138
diff changeset
422 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
423
2166
cd42c3c7173a MySQL and Postgresql use BOOL/BOOLEAN for Boolean types
Richard Jones <richard@users.sourceforge.net>
parents: 2149
diff changeset
424 If the file is of type message/rfc822, we tack on the extension .mht.
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
425
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
426 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
427 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
428 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
429 information, please see:
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
430
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
431 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
432
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
433 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
434
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
435 WORKAROUND
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
436
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
437 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
438 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
439 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
440
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
441 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
442 the URL links.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
443 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
444 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
445 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
446 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
447 name extension.
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
448
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
449
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
450 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
451 ----------------------------
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
452
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
453 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
454 to another. Example usage::
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
455
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
456 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
457
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
458 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
459
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
460
2149
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
461 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
462 ------------------
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
463
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
464 - 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
465 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
466
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
467 - 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
468 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
469 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
470 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
471
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
472 - 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
473 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
474 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
475
2182
7c0ed51cc865 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2180
diff changeset
476 - The roundup-admin "export" and "import" commands now handle the database
7c0ed51cc865 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2180
diff changeset
477 journals too. This means that exports from previous versions of Roundup
7c0ed51cc865 *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 2180
diff changeset
478 will not work under 0.7!
2149
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
479
702f9a6afdcf Added DEFAULT_TIMEZONE. Fixed up some missing info from What's New.
Richard Jones <richard@users.sourceforge.net>
parents: 2147
diff changeset
480
2138
f76d1642014a doc cleanup, editing and creation of a What's New
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
481 .. _`customisation documentation`: customizing.html
Roundup Issue Tracker: http://roundup-tracker.org/