Skip to content

Commit e09e6b4

Browse files
committed
Rephrase sentence and clean up whitespace.
1 parent 293c1a0 commit e09e6b4

File tree

1 file changed

+30
-30
lines changed

1 file changed

+30
-30
lines changed

doc/upgrading.txt

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ Roundup used to allow certain HTML-Tags in OK- and Error-messages. Since
2020
these messages are passed via the URL (due to roundup redirecting after
2121
an edit), we did have security-issues (see issue2550724).
2222

23-
If you have customized OK- or Error messages in your
24-
roundup-installation and you're were using features like bold or italic
25-
parts of the message you will have to do without this highlighting and
23+
If you have customized the OK or Error messages in your
24+
roundup-installation and you were using features like bold or italic
25+
in the message, you will have to do without this highlighting and
2626
remove HTML tags from messages.
2727

2828
If you were using <br> tags for multi-line messages, you now should use
@@ -121,10 +121,10 @@ search for this property::
121121
#!/usr/bin/python
122122
import os
123123
from roundup import instance
124-
124+
125125
tracker = instance.open(os.getcwd ())
126126
db = tracker.open('admin')
127-
127+
128128
for cl in sorted(db.getclasses()):
129129
print "Class:", cl
130130
for p in sorted(db.getclass(cl).properties.keys()):
@@ -220,7 +220,7 @@ assign it to the Anonymous role (replacing any previously assigned
220220

221221
+db.security.addPermission(name='Register', klass='user',
222222
+ description='User is allowed to register new user')
223-
223+
224224
# Assign the appropriate permissions to the anonymous user's Anonymous
225225
# Role. Choices here are:
226226
# - Allow anonymous users to register
@@ -398,7 +398,7 @@ Migrating from 1.4.x to 1.4.2
398398
=============================
399399

400400
You should run the "roundup-admin migrate" command for your tracker once
401-
you've installed the latest codebase.
401+
you've installed the latest codebase.
402402

403403
Do this before you use the web, command-line or mail interface and before
404404
any users access the tracker.
@@ -462,7 +462,7 @@ lists. This is reflected in several places:
462462

463463
* ``renderWith`` now has list attributes for ``sort`` and ``group``,
464464
where you previously wrote::
465-
465+
466466
renderWith(... sort=('-', 'activity'), group=('+', 'priority')
467467

468468
you write now::
@@ -675,7 +675,7 @@ The ``dbinit.py`` file has been split into two new files,
675675
tracker's ``dbinit.py`` file to this file. As the lines you're copying
676676
aren't part of a function definition anymore, one level of indentation
677677
needs to be removed (remove only the leading four spaces on each
678-
line).
678+
line).
679679

680680
The first few lines -- those starting with ``from roundup.hyperdb
681681
import ...`` and the ``db = Database(config, name)`` line -- don't
@@ -735,11 +735,11 @@ own details by adding the following to ``schema.py``::
735735
----------------------------
736736

737737
If you used custom python functions in TemplatingUtils, they must
738-
be moved from interfaces.py to a new file in the ``extensions`` directory.
738+
be moved from interfaces.py to a new file in the ``extensions`` directory.
739739

740740
Each Function that should be available through TAL needs to be defined
741741
as a toplevel function in the newly created file. Furthermore you
742-
add an inititialization function, that registers the functions with the
742+
add an inititialization function, that registers the functions with the
743743
tracker.
744744

745745
If you find this too tedious, donfu wrote an automatic init function that
@@ -838,7 +838,7 @@ Due to a change in the rendering of web widgets, permissions are now
838838
checked on Classes where they previously weren't (this is a good thing).
839839

840840
You will need to add some additional Permission assignments for your
841-
regular users, or some displays will break. After the following in your
841+
regular users, or some displays will break. After the following in your
842842
tracker's ``dbinit.py``::
843843

844844
# Assign the access and edit Permissions for issue, file and message
@@ -972,11 +972,11 @@ Added internationalization support. This is done via encoding all data
972972
stored in roundup database to utf-8 (unicode encoding). To support utf-8 in
973973
web interface you should add the folowing line to your tracker's html/page
974974
and html/_generic.help files inside <head> tag::
975-
975+
976976
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
977977

978978
Since latin characters in utf-8 have the same codes as in ASCII table, this
979-
modification is optional for users who use only plain latin characters.
979+
modification is optional for users who use only plain latin characters.
980980

981981
After this modification, you will be able to see and enter any world
982982
character via web interface. Data received via mail interface also converted
@@ -997,18 +997,18 @@ timezone if he/she has provided timezone information. To make it possible
997997
some modification to tracker's schema and HTML templates are required.
998998
First you must add string property 'timezone' to user class in dbinit.py
999999
like this::
1000-
1001-
user = Class(db, "user",
1000+
1001+
user = Class(db, "user",
10021002
username=String(), password=Password(),
1003-
address=String(), realname=String(),
1003+
address=String(), realname=String(),
10041004
phone=String(), organisation=String(),
10051005
alternate_addresses=String(),
10061006
queries=Multilink('query'), roles=String(),
10071007
timezone=String())
1008-
1008+
10091009
And second - html interface. Add following lines to
10101010
$TRACKER_HOME/html/user.item template::
1011-
1011+
10121012
<tr>
10131013
<th>Timezone</th>
10141014
<td tal:content="structure context/timezone/field">timezone</td>
@@ -1412,7 +1412,7 @@ changing from::
14121412

14131413
from roundup import cgi_client, mailgw
14141414
from roundup.i18n import _
1415-
1415+
14161416
class Client(cgi_client.Client):
14171417
''' derives basic CGI implementation from the standard module,
14181418
with any specific extensions
@@ -1423,8 +1423,8 @@ to::
14231423

14241424
from roundup import mailgw
14251425
from roundup.cgi import client
1426-
1427-
class Client(client.Client):
1426+
1427+
class Client(client.Client):
14281428
''' derives basic CGI implementation from the standard module,
14291429
with any specific extensions
14301430
'''
@@ -1466,7 +1466,7 @@ the replacement behaviour to occur now.
14661466

14671467
The new configuration variables are:
14681468

1469-
- EMAIL_KEEP_QUOTED_TEXT
1469+
- EMAIL_KEEP_QUOTED_TEXT
14701470
- EMAIL_LEAVE_BODY_UNCHANGED
14711471
- ADD_RECIPIENTS_TO_NOSY
14721472

@@ -1579,15 +1579,15 @@ the classic schema, the interfaces file is in::
15791579

15801580
If you used the extended schema, the file is in::
15811581

1582-
<roundup source>/roundup/templates/extended/dbinit.py
1582+
<roundup source>/roundup/templates/extended/dbinit.py
15831583

15841584
If you have modified your dbinit.py file, you need to edit the dbinit.py
15851585
file in your instance home directory. Find the lines which define the user
15861586
class::
15871587

15881588
user = Class(db, "msg",
15891589
username=String(), password=Password(),
1590-
address=String(), realname=String(),
1590+
address=String(), realname=String(),
15911591
phone=String(), organisation=String(),
15921592
alternate_addresses=String())
15931593

@@ -1618,7 +1618,7 @@ classic schema, the interfaces file is in::
16181618

16191619
If you used the extended schema, the file is in::
16201620

1621-
<roundup source>/roundup/templates/extended/dbinit.py
1621+
<roundup source>/roundup/templates/extended/dbinit.py
16221622

16231623
If you have modified your dbinit.py file, you need to edit the dbinit.py
16241624
file in your instance home directory. Find the lines which define the msg
@@ -1734,17 +1734,17 @@ If you have modified your dbinit.py file, you may use encoded passwords:
17341734

17351735
b. Where the password property is defined (around line 66)::
17361736

1737-
user = Class(db, "user",
1737+
user = Class(db, "user",
17381738
username=String(), password=String(),
1739-
address=String(), realname=String(),
1739+
address=String(), realname=String(),
17401740
phone=String(), organisation=String())
17411741
user.setkey("username")
17421742

17431743
alter the "password=String()" to "password=Password()"::
17441744

1745-
user = Class(db, "user",
1745+
user = Class(db, "user",
17461746
username=String(), password=Password(),
1747-
address=String(), realname=String(),
1747+
address=String(), realname=String(),
17481748
phone=String(), organisation=String())
17491749
user.setkey("username")
17501750

0 commit comments

Comments
 (0)