Mercurial > p > roundup > code
comparison doc/upgrading.txt @ 1638:4a47eb555e51
more doc
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Fri, 09 May 2003 04:04:27 +0000 |
| parents | 33a0d94c7658 |
| children | 3d4ad125662b |
comparison
equal
deleted
inserted
replaced
| 1637:e72158c2f831 | 1638:4a47eb555e51 |
|---|---|
| 11 ========================= | 11 ========================= |
| 12 | 12 |
| 13 0.6.0 Configuration | 13 0.6.0 Configuration |
| 14 ------------------- | 14 ------------------- |
| 15 | 15 |
| 16 - Introduced EMAIL_FROM_TAG config variable. This value is inserted into | 16 Introduced EMAIL_FROM_TAG config variable. This value is inserted into |
| 17 the From: line of nosy email. If the sending user is "Foo Bar", the | 17 the From: line of nosy email. If the sending user is "Foo Bar", the |
| 18 From: line is usually:: | 18 From: line is usually:: |
| 19 | 19 |
| 20 "Foo Bar" <issue_tracker@tracker.example> | 20 "Foo Bar" <issue_tracker@tracker.example> |
| 21 | 21 |
| 22 the EMAIL_FROM_TAG goes inside the "Foo Bar" quotes like so:: | 22 the EMAIL_FROM_TAG goes inside the "Foo Bar" quotes like so:: |
| 23 | 23 |
| 24 "Foo Bar EMAIL_FROM_TAG" <issue_tracker@tracker.example> | 24 "Foo Bar EMAIL_FROM_TAG" <issue_tracker@tracker.example> |
| 25 | 25 |
| 26 I've altered the mechanism in the detectors __init__.py module so that it | 26 I've altered the mechanism in the detectors __init__.py module so that it |
| 27 doesn't cross-import detectors from other trackers (if you run more than one | 27 doesn't cross-import detectors from other trackers (if you run more than one |
| 32 | 32 |
| 33 | 33 |
| 34 0.6.0 Form handling changes | 34 0.6.0 Form handling changes |
| 35 --------------------------- | 35 --------------------------- |
| 36 | 36 |
| 37 XXX Form handling changed significantly! Document it! | 37 Roundup's form handling capabilities have been significantly expanded. This |
| 38 | 38 should not affect users of 0.5 installations - but if you find you're |
| 39 lose :multilink | 39 getting errors from form submissions, please ask for help on the Roundup |
| 40 name:confirm -> :confirm:name | 40 users mailing list: |
| 41 | |
| 42 http://lists.sourceforge.net/lists/listinfo/roundup-users | |
| 43 | |
| 44 See the customisation doc section on "Form Values" for documentation of the | |
| 45 new form variables possible. | |
| 41 | 46 |
| 42 | 47 |
| 43 0.6.0 Multilingual character set support | 48 0.6.0 Multilingual character set support |
| 44 ---------------------------------------- | 49 ---------------------------------------- |
| 45 | 50 |
| 46 - Added internationalization support. This is done via encoding all data | 51 Added internationalization support. This is done via encoding all data |
| 47 stored in roundup database to utf-8 (unicode encoding). To support utf-8 in | 52 stored in roundup database to utf-8 (unicode encoding). To support utf-8 in |
| 48 web interface you should add the folowing line to your tracker's html/page | 53 web interface you should add the folowing line to your tracker's html/page |
| 49 and html/_generic.help files inside <head> tag:: | 54 and html/_generic.help files inside <head> tag:: |
| 50 | 55 |
| 51 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | 56 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
| 52 | 57 |
| 53 Since latin characters in utf-8 has the same codes as in ASCII table, this | 58 Since latin characters in utf-8 have the same codes as in ASCII table, this |
| 54 modification is optional for users who use only plain latin characters. | 59 modification is optional for users who use only plain latin characters. |
| 55 | 60 |
| 56 After this modification, you will be able to see and enter any world | 61 After this modification, you will be able to see and enter any world |
| 57 character via web interface. Data received via mail interface also converted | 62 character via web interface. Data received via mail interface also converted |
| 58 to utf-8, however only new messages will be converted. If your roundup | 63 to utf-8, however only new messages will be converted. If your roundup |
| 59 database contains some of non-ASCII characters in one of 8-bit encoding, | 64 database contains some of non-ASCII characters in one of 8-bit encoding, |
| 60 they will not be visible in new unicode environment. Some of such data (e.g. | 65 they will not be visible in new unicode environment. Some of such data (e.g. |
| 61 user names, keywords, etc) can be edited by administrator, the others | 66 user names, keywords, etc) can be edited by administrator, the others |
| 62 (e.g. messages' contents) is not editable via web interface. Currently there | 67 (e.g. messages' contents) is not editable via web interface. Currently there |
| 63 is no tool for converting such data, the only solution is to close | 68 is no tool for converting such data, the only solution is to close |
| 64 appropriate old issues and create new ones with the same content. | 69 appropriate old issues and create new ones with the same content. |
| 65 | 70 |
| 66 0.6.0 User' timezone support | 71 0.6.0 User timezone support |
| 67 ---------------------------- | 72 --------------------------- |
| 68 | 73 |
| 69 - From version 0.6.0 roundup supports displaying of Date data in user' local | 74 From version 0.6.0 roundup supports displaying of Date data in user' local |
| 70 timezone if he/she has provided timezone information. To make it possible | 75 timezone if he/she has provided timezone information. To make it possible |
| 71 some modification to tracker's schema and HTML templates are required. | 76 some modification to tracker's schema and HTML templates are required. |
| 72 First you should add string property 'timezone' to user class in dbinit.py | 77 First you should add string property 'timezone' to user class in dbinit.py |
| 73 like this:: | 78 like this:: |
| 74 | 79 |
| 75 user = Class(db, "user", | 80 user = Class(db, "user", |
| 76 username=String(), password=Password(), | 81 username=String(), password=Password(), |
| 77 address=String(), realname=String(), | 82 address=String(), realname=String(), |
| 78 phone=String(), organisation=String(), | 83 phone=String(), organisation=String(), |
| 79 alternate_addresses=String(), | 84 alternate_addresses=String(), |
| 80 queries=Multilink('query'), roles=String(), | 85 queries=Multilink('query'), roles=String(), |
| 81 timezone=String()) | 86 timezone=String()) |
| 82 | 87 |
| 83 And second - html interface. Add following lines to | 88 And second - html interface. Add following lines to |
| 84 $TRACKER_HOME/html/user.item template:: | 89 $TRACKER_HOME/html/user.item template:: |
| 85 | 90 |
| 86 <tr> | 91 <tr> |
| 87 <th>Timezone</th> | 92 <th>Timezone</th> |
| 88 <td tal:content="structure context/timezone/field">timezone</td> | 93 <td tal:content="structure context/timezone/field">timezone</td> |
| 89 </tr> | 94 </tr> |
| 90 | 95 |
| 91 After that all users should be able to provide their timezone information. | 96 After that all users should be able to provide their timezone information. |
| 92 Timezone should be a positive or negative integer - offset from GMT. | 97 Timezone should be a positive or negative integer - offset from GMT. |
| 93 | 98 |
| 94 After providing timezone, roundup will show all dates values, found in web | 99 After providing timezone, roundup will show all dates values, found in web |
| 95 and mail interfaces in local time. It will also accept any Date info in | 100 and mail interfaces in local time. It will also accept any Date info in |
| 96 local time, convert and store it in GMT. | 101 local time, convert and store it in GMT. |
| 97 | 102 |
| 98 However you are not forced to make these modifications. By default roundup | 103 However you are not forced to make these modifications. By default roundup |
| 99 will assume timezone=0 and will work as previous versions did. | 104 will assume timezone=0 and will work as previous versions did. |
| 100 | 105 |
| 101 | 106 |
| 102 0.6.0 Notes for metakit backend users | 107 0.6.0 Notes for metakit backend users |
| 103 ------------------------------------- | 108 ------------------------------------- |
| 104 | 109 |
| 105 - Roundup 0.6.0 introduced searching on ranges of dates and intervals. To | 110 Roundup 0.6.0 introduced searching on ranges of dates and intervals. To |
| 106 support it, some modifications to interval storing routine were made. So if | 111 support it, some modifications to interval storing routine were made. So if |
| 107 your tracker uses metakit backend and your db schema contains intervals | 112 your tracker uses metakit backend and your db schema contains intervals |
| 108 property, searches on that property will not be accurate for db items that | 113 property, searches on that property will not be accurate for db items that |
| 109 was stored before roundup' upgrade. However all new records should be | 114 was stored before roundup' upgrade. However all new records should be |
| 110 searchable on intervals. | 115 searchable on intervals. |
| 111 | 116 |
| 112 It is possible to convert your database to new format: you can export and | 117 It is possible to convert your database to new format: you can export and |
| 113 import back all your data (consult "Migrating backends" in "Maintenance" | 118 import back all your data (consult "Migrating backends" in "Maintenance" |
| 114 documentation). After this operation all your interval properties should | 119 documentation). After this operation all your interval properties should |
| 115 become searchable. | 120 become searchable. |
| 116 | 121 |
| 117 Users of backends others than metakit should not worry about this issue. | 122 Users of backends others than metakit should not worry about this issue. |
| 118 | 123 |
| 119 | 124 |
| 120 Migrating from 0.4.x to 0.5.0 | 125 Migrating from 0.4.x to 0.5.0 |
| 121 ============================= | 126 ============================= |
| 122 | 127 |
