Skip to content

Commit 4c085f3

Browse files
author
Richard Jones
committed
doc cleanup, editing and creation of a What's New
1 parent 1a8379e commit 4c085f3

File tree

8 files changed

+402
-162
lines changed

8 files changed

+402
-162
lines changed

doc/.cvsignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,4 @@ overview.html
1616
mysql.html
1717
postgresql.html
1818
tracker_templates.html
19+
whatsnew-0.7.html

doc/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ STXTOHTML = rst2html
44
SOURCE = announcement.txt customizing.txt developers.txt FAQ.txt features.txt \
55
glossary.txt implementation.txt index.txt design.txt mysql.txt \
66
installation.txt upgrading.txt user_guide.txt admin_guide.txt \
7-
postgresql.txt tracker_templates.txt
7+
postgresql.txt tracker_templates.txt whatsnew-0.7.txt
88

99
COMPILED := $(SOURCE:.txt=.html)
1010

doc/customizing.txt

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Customising Roundup
33
===================
44

5-
:Version: $Revision: 1.124 $
5+
:Version: $Revision: 1.125 $
66

77
.. This document borrows from the ZopeBook section on ZPT. The original is at:
88
http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
@@ -599,6 +599,7 @@ Generally speaking, the following rules should be observed:
599599
making changes to the database where possible, as this could create
600600
detector loops.
601601

602+
602603
Vetoing creation of or changes to items
603604
---------------------------------------
604605

@@ -617,6 +618,18 @@ And then when your rejection criteria have been detected, simply::
617618
raise Reject
618619

619620

621+
Generating email from Roundup
622+
-----------------------------
623+
624+
The module ``roundup.mailer`` contains most of the nuts-n-bolts required
625+
to generate email messages from Roundup.
626+
627+
In addition, the ``IssueClass`` methods ``nosymessage()`` and
628+
``send_message()`` are used to generate nosy messages, and may generate
629+
messages which only consist of a change note (ie. the message id parameter
630+
is not required).
631+
632+
620633
Database Content
621634
================
622635

@@ -1670,6 +1683,18 @@ reverse only on Multilink properties - produce a list of the linked
16701683
items in reverse order
16711684
=========== ================================================================
16721685

1686+
All of the above functions perform checks for permissions required to
1687+
display or edit the data they are manipulating. The simplest case is
1688+
editing an issue title. Including the expression::
1689+
1690+
context/title/field
1691+
1692+
Will present the user with an edit field, if they have edit permission. If
1693+
not, then they will be presented with a static display if they have view
1694+
permission. If they don't even have view permission, then an error message
1695+
is raised, preventing the display of the page, indicating that they don't
1696+
have permission to view the information.
1697+
16731698

16741699
The request variable
16751700
~~~~~~~~~~~~~~~~~~~~

doc/features.txt

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ from Ka-Ping Yee in the Software Carpentry "Track" design competition.
1111
- two templates included in the distribution for you to base your tracker on
1212
- doesn't need *any* additional support software - python (2.1+) is enough to
1313
get you going
14-
- easy to set up higher-performance storage backends like sqlite_ and
15-
metakit_
14+
- easy to set up higher-performance storage backends like sqlite_,
15+
metakit_, mysql and postgresql
1616
- the really impatient can try the instant-gratification Demo Mode (``python
1717
demo.py``)
1818

@@ -29,13 +29,16 @@ from Ka-Ping Yee in the Software Carpentry "Track" design competition.
2929
with a full set of data types (including dates and many-to-many relations)
3030
across all storages available
3131
- customised automatic auditors and reactors may be written that perform
32-
actions before and after changes are made to entries in the database
32+
actions before and after changes are made to entries in the database,
33+
or may veto the creation or modification of items int he database
3334
- samples are provided for all types of configuration changes
3435

3536
*fast, scalable*
36-
- with the sqlite_, metakit_ and mysql backends, roundup is also fast and
37-
scalable, easily handling thousands of issues and users with decent
38-
response times
37+
- with the sqlite, metakit, mysql and postgresql backends, roundup is
38+
also fast and scalable, easily handling thousands of issues and users
39+
with decent response times
40+
- database indexes are automatically added for those backends that
41+
support them (sqlite, metakit, mysql and postgresql)
3942
- indexed text searching giving fast responses to searches across all
4043
messages and indexed string properties
4144

doc/index.txt

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@ Contents
1818
- Acknowledgements_
1919
- License_
2020

21-
.. __: features.html
22-
.. __: installation.html
23-
.. __: upgrading.html
24-
.. __: FAQ.html
25-
.. __: user_guide.html
26-
.. __: customizing.html
27-
.. __: admin_guide.html
28-
.. __: design.html
29-
.. __: spec.html
30-
.. __: developers.html
31-
.. __: tracker_templates.html
21+
__ features.html
22+
__ installation.html
23+
__ upgrading.html
24+
__ FAQ.html
25+
__ user_guide.html
26+
__ customizing.html
27+
__ admin_guide.html
28+
__ design.html
29+
__ spec.html
30+
__ developers.html
31+
__ tracker_templates.html
3232

3333
Contact
3434
=======

doc/upgrading.txt

Lines changed: 0 additions & 142 deletions
Original file line numberDiff line numberDiff line change
@@ -12,116 +12,6 @@ accordingly. Note that there is information about upgrade procedures in the
1212
Migrating from 0.6 to 0.7
1313
=========================
1414

15-
0.7.0 Saving and sharing of user queries
16-
----------------------------------------
17-
18-
Due to popular demand, the user query saving mechanisms have been
19-
overhauled. This means that queries remember the user that created them
20-
and they may be marked as being private for a particular user.
21-
22-
You *are not required* to make these changes. You only need to make them
23-
if you wish to use the new query editing features. It's highly
24-
recommended, as the effort is minimal.
25-
26-
1. You will need to edit your tracker's ``dbinit.py`` to change the way
27-
queries are stored. Change the lines::
28-
29-
query = Class(db, "query",
30-
klass=String(), name=String(),
31-
url=String())
32-
query.setkey("name")
33-
34-
to::
35-
36-
query = Class(db, "query",
37-
klass=String(), name=String(),
38-
url=String(), private_for=Link('user'))
39-
40-
That is, add the "private_for" property, and remove the line that says
41-
``query.setkey("name")``. The latter is the most important edit here.
42-
43-
2. You will also need to copy the ``query.edit.html`` template page from the
44-
``templates/classic/html/`` directory of the source to your tracker's
45-
``html`` directory.
46-
47-
3. Once you've done that, edit the tracker's ``page.html`` template to
48-
change::
49-
50-
<td rowspan="2" valign="top" class="sidebar">
51-
<p class="classblock" tal:condition="request/user/queries">
52-
<b>Your Queries</b><br>
53-
<tal:block tal:repeat="qs request/user/queries">
54-
55-
to::
56-
57-
<td rowspan="2" valign="top" class="sidebar">
58-
<p class="classblock">
59-
<b>Your Queries</b> (<a href="query?@template=edit">edit</a>)<br>
60-
<tal:block tal:repeat="qs request/user/queries">
61-
62-
That is, you're removing the ``tal:condition`` and adding a link to the
63-
new edit page.
64-
65-
4. You might also wish to remove the redundant query editing section from the
66-
``user.item.html`` page.
67-
68-
69-
0.7.0 Added Dispatcher role
70-
---------------------------
71-
72-
A new config option has been added that specifies the email address of
73-
a "dispatcher" role. This email address acts as a central sentinel for
74-
issues coming into the system. You can configure it so that all e-mail
75-
error messages get bounced to them, them and the user in question, or
76-
just the user (default).
77-
78-
To toggle these switches, add the "DISPATCHER_EMAIL" and
79-
"ERROR_MESSAGES_TO" configuration values to your tracker's ``config.py``.
80-
See the `customisation documentation`_ for how to use them.
81-
82-
83-
0.7.0 Added CSV export action
84-
-----------------------------
85-
86-
A new action has been added which exports the current index page or search
87-
result as a comma-separated-value (CSV) file.
88-
89-
To use it, add this to your "index" templates:
90-
91-
<a tal:attributes="href python:request.indexargs_url('issue',
92-
{'@action':'csv_export'})">Download as CSV</a>
93-
94-
Making sure that the ``'issue'`` part matches the class name of the page
95-
you're editing.
96-
97-
98-
0.7.0 Typed columns in MySQL backend
99-
------------------------------------
100-
101-
The MySQL (and Postgresql for that matter) backend now creates tables with
102-
appropriate column datatypes (not just varchar).
103-
104-
Your database will be automatically migrated to use the new schemas, but
105-
it will take time. It's probably a good idea to make sure you do this as
106-
part of the upgrade when users are not expected to be using the system.
107-
108-
109-
0.7.0 Permission setup
110-
----------------------
111-
112-
0.7 automatically sets up the Edit and View Permissions for all classes,
113-
thus you don't need to do so. Feel free to remove the code::
114-
115-
# Add new Permissions for this schema
116-
for cl in 'issue', 'file', 'msg', 'user', 'query', 'keyword':
117-
db.security.addPermission(name="Edit", klass=cl,
118-
description="User is allowed to edit "+cl)
119-
db.security.addPermission(name="View", klass=cl,
120-
description="User is allowed to access "+cl)
121-
122-
from your ``dbinit.py``.
123-
124-
12515
0.7.0 Permission assignments
12616
----------------------------
12717

@@ -147,45 +37,13 @@ add::
14737
db.security.addPermissionToRole('User', p)
14838

14939

150-
0.7.0 New "actor" property
151-
--------------------------
152-
153-
Roundup's database has a new per-item property "actor" which reflects the
154-
user performing the last "actvitiy". See the classic template for ways to
155-
integrate this new property into your interface.
156-
157-
The property will be automatically added to your existing database.
158-
159-
160-
0.7.0 Extending the cgi interface
161-
---------------------------------
162-
163-
Before 0.7.0 adding or extending web actions was done by overriding or adding
164-
methods on the Client class. Though this approach still works to provide
165-
backwards compatibility, it is recommended you upgrade to the new approach, as
166-
described in the `Defining new web actions`__ section of the customization
167-
documentation. You might also want to take a look at the `Using an external
168-
password validation source`__ example.
169-
170-
__ customizing.html#defining-new-web-actions
171-
__ customizing.html#using-an-external-password-validation-source
172-
173-
17440
0.7.0 Getting the current user id
17541
---------------------------------
17642

17743
Removed Database.curuserid attribute. Any code referencing this attribute
17844
should be replaced with a call to Database.getuid().
17945

18046

181-
0.7.0 Email character set
182-
-------------------------
183-
184-
The default character set for sending email is UTF-8 (ie. Unicode). If you
185-
have users whose email clients can't handle UTF-8 (eg. Eudora) then you
186-
will need to edit the new config.py variable ``EMAIL_CHARSET``.
187-
188-
18947
0.7.0 ZRoundup changes
19048
----------------------
19149

doc/user_guide.txt

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
User Guide
33
==========
44

5-
:Version: $Revision: 1.26 $
5+
:Version: $Revision: 1.27 $
66

77
.. contents::
88

@@ -176,6 +176,14 @@ XXX explain...
176176
When searching on interval properties use the same syntax as for dates.
177177

178178

179+
Simple support for collision detection
180+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
181+
182+
Item edit pages remember when the item was last edited. When a form is
183+
submitted, the user will be informed if someone else has edited the item
184+
at the same time they tried to.
185+
186+
179187
Web Interface
180188
=============
181189

0 commit comments

Comments
 (0)