Code

rfc2822-ify the tracker name in mail headers
[roundup.git] / doc / upgrading.txt
index 27f241443100fd6c3013f43231f231ac7e61b7ff..8b722239d65adcc0c914912c625b237d1792634b 100644 (file)
@@ -7,6 +7,89 @@ accordingly.
 
 .. contents::
 
+Migrating from 0.5 to 0.6
+=========================
+
+0.6.0 Configuration
+-------------------
+
+- Introduced EMAIL_FROM_TAG config variable. This value is inserted into
+  the From: line of nosy email. If the sending user is "Foo Bar", the
+  From: line is usually::
+
+     "Foo Bar" <issue_tracker@tracker.example>
+
+  the EMAIL_FROM_TAG goes inside the "Foo Bar" quotes like so::
+
+     "Foo Bar EMAIL_FROM_TAG" <issue_tracker@tracker.example>
+
+0.6.0 Form handling changes
+---------------------------
+
+XXX Form handling changed significantly! Document it!
+
+lose :multilink
+name:confirm -> :confirm:name
+
+
+0.6.0 Multilingual character set support
+----------------------------------------
+
+- Added internationalization support. This is done via encoding all data
+  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 has the same codes as in ASCII table, this
+  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
+  to utf-8, however only new messages will be converted. If your roundup
+  database contains some of non-ASCII characters in one of 8-bit encoding,
+  they will not be visible in new unicode environment. Some of such data (e.g.
+  user names, keywords, etc)  can be edited by administrator, the others
+  (e.g. messages' contents) is not editable via web interface. Currently there
+  is no tool for converting such data, the only solution is to close
+  appropriate old issues and create new ones with the same content.
+
+0.6.0 User' timezone support
+----------------------------
+
+- From version 0.6.0 roundup supports displaying of Date data in user' local
+  timezone if he/she has provided timezone information. To make it possible
+  some modification to tracker's schema and HTML templates are required.
+  First you should add string property 'timezone' to user class in dbinit.py
+  like this:
+  
+    user = Class(db, "user", 
+                    username=String(),   password=Password(),
+                    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>
+        </tr>
+
+  After that all users should be able to provide their timezone information.
+  Timezone should be a positive or negative integer - offset from GMT.
+
+  After providing timezone, roundup will show all dates values, found in web
+  and mail interfaces in local time. It will also accept any Date info in
+  local time, convert and store it in GMT.
+
+  However you are not forced to make these modifications. By default roundup
+  will assume timezone=0 and will work as previous versions did.
+
 Migrating from 0.4.x to 0.5.0
 =============================