Commits

Ezio Melotti  committed 519a22c Draft

Rephrase sentence and clean up whitespace.

  • Participants
  • Parent commits a099ff2

Comments (0)

Files changed (1)

File doc/upgrading.txt

 these messages are passed via the URL (due to roundup redirecting after
 an edit), we did have security-issues (see issue2550724).
 
-If you have customized OK- or Error messages in your
-roundup-installation and you're were using features like bold or italic
-parts of the message you will have to do without this highlighting and
+If you have customized the OK or Error messages in your
+roundup-installation and you were using features like bold or italic
+in the message, you will have to do without this highlighting and
 remove HTML tags from messages.
 
 If you were using <br> tags for multi-line messages, you now should use
     #!/usr/bin/python
     import os
     from roundup import instance
-    
+
     tracker = instance.open(os.getcwd ())
     db = tracker.open('admin')
-    
+
     for cl in sorted(db.getclasses()):
         print "Class:", cl
         for p in sorted(db.getclass(cl).properties.keys()):
 
   +db.security.addPermission(name='Register', klass='user',
   +     description='User is allowed to register new user')
- 
+
    # Assign the appropriate permissions to the anonymous user's Anonymous
    # Role. Choices here are:
    # - Allow anonymous users to register
 =============================
 
 You should run the "roundup-admin migrate" command for your tracker once
-you've installed the latest codebase. 
+you've installed the latest codebase.
 
 Do this before you use the web, command-line or mail interface and before
 any users access the tracker.
 
  * ``renderWith`` now has list attributes for ``sort`` and ``group``,
    where you previously wrote::
-   
+
     renderWith(... sort=('-', 'activity'), group=('+', 'priority')
 
    you write now::
   tracker's ``dbinit.py`` file to this file. As the lines you're copying
   aren't part of a function definition anymore, one level of indentation
   needs to be removed (remove only the leading four spaces on each
-  line). 
+  line).
 
   The first few lines -- those starting with ``from roundup.hyperdb
   import ...`` and the ``db = Database(config, name)`` line -- don't
 ----------------------------
 
 If you used custom python functions in TemplatingUtils, they must
-be moved from interfaces.py to a new file in the ``extensions`` directory. 
+be moved from interfaces.py to a new file in the ``extensions`` directory.
 
 Each Function that should be available through TAL needs to be defined
 as a toplevel function in the newly created file. Furthermore you
-add an inititialization function, that registers the functions with the 
+add an inititialization function, that registers the functions with the
 tracker.
 
 If you find this too tedious, donfu wrote an automatic init function that
 checked on Classes where they previously weren't (this is a good thing).
 
 You will need to add some additional Permission assignments for your
-regular users, or some displays will break. After the following in your 
+regular users, or some displays will break. After the following in your
 tracker's ``dbinit.py``::
 
     # Assign the access and edit Permissions for issue, file and message
 stored in roundup database to utf-8 (unicode encoding). To support utf-8 in
 web interface you should add the folowing line to your tracker's html/page
 and html/_generic.help files inside <head> tag::
-  
+
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
 
 Since latin characters in utf-8 have the same codes as in ASCII table, this
-modification is optional for users who use only plain latin characters. 
+modification is optional for users who use only plain latin characters.
 
 After this modification, you will be able to see and enter any world
 character via web interface. Data received via mail interface also converted
 some modification to tracker's schema and HTML templates are required.
 First you must add string property 'timezone' to user class in dbinit.py
 like this::
-  
-    user = Class(db, "user", 
+
+    user = Class(db, "user",
                     username=String(),   password=Password(),
-                    address=String(),    realname=String(), 
+                    address=String(),    realname=String(),
                     phone=String(),      organisation=String(),
                     alternate_addresses=String(),
                     queries=Multilink('query'), roles=String(),
                     timezone=String())
-  
+
 And second - html interface. Add following lines to
 $TRACKER_HOME/html/user.item template::
-  
+
      <tr>
       <th>Timezone</th>
       <td tal:content="structure context/timezone/field">timezone</td>
 
  from roundup import cgi_client, mailgw
  from roundup.i18n import _
- 
+
  class Client(cgi_client.Client):
      ''' derives basic CGI implementation from the standard module,
          with any specific extensions
 
  from roundup import mailgw
  from roundup.cgi import client
- 
- class Client(client.Client): 
+
+ class Client(client.Client):
      ''' derives basic CGI implementation from the standard module,
          with any specific extensions
      '''
 
 The new configuration variables are:
 
-- EMAIL_KEEP_QUOTED_TEXT 
+- EMAIL_KEEP_QUOTED_TEXT
 - EMAIL_LEAVE_BODY_UNCHANGED
 - ADD_RECIPIENTS_TO_NOSY
 
 
 If you used the extended schema, the file is in::
 
- <roundup source>/roundup/templates/extended/dbinit.py 
+ <roundup source>/roundup/templates/extended/dbinit.py
 
 If you have modified your dbinit.py file, you need to edit the dbinit.py
 file in your instance home directory. Find the lines which define the user
 
     user = Class(db, "msg",
                     username=String(),   password=Password(),
-                    address=String(),    realname=String(), 
+                    address=String(),    realname=String(),
                     phone=String(),      organisation=String(),
                     alternate_addresses=String())
 
 
 If you used the extended schema, the file is in::
 
- <roundup source>/roundup/templates/extended/dbinit.py 
+ <roundup source>/roundup/templates/extended/dbinit.py
 
 If you have modified your dbinit.py file, you need to edit the dbinit.py
 file in your instance home directory. Find the lines which define the msg
 
    b. Where the password property is defined (around line 66)::
 
-       user = Class(db, "user", 
+       user = Class(db, "user",
                        username=String(),   password=String(),
-                       address=String(),    realname=String(), 
+                       address=String(),    realname=String(),
                        phone=String(),      organisation=String())
        user.setkey("username")
 
       alter the "password=String()" to "password=Password()"::
 
-       user = Class(db, "user", 
+       user = Class(db, "user",
                        username=String(),   password=Password(),
-                       address=String(),    realname=String(), 
+                       address=String(),    realname=String(),
                        phone=String(),      organisation=String())
        user.setkey("username")