From f711665166dd8e45ead2ed13824b6b20df84eb8e Mon Sep 17 00:00:00 2001 From: richard Date: Fri, 9 May 2003 04:04:27 +0000 Subject: [PATCH] more doc git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/trunk@1704 57a73879-2fb5-44c3-a270-3262357dd7e2 --- doc/customizing.txt | 67 ++++++++++++++++++++++++++- doc/upgrading.txt | 103 ++++++++++++++++++++++-------------------- roundup/cgi/client.py | 8 ++-- 3 files changed, 124 insertions(+), 54 deletions(-) diff --git a/doc/customizing.txt b/doc/customizing.txt index 8285fb5..5711dff 100644 --- a/doc/customizing.txt +++ b/doc/customizing.txt @@ -2,7 +2,7 @@ Customising Roundup =================== -:Version: $Revision: 1.84 $ +:Version: $Revision: 1.85 $ .. This document borrows from the ZopeBook section on ZPT. The original is at: http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx @@ -1630,7 +1630,6 @@ template. It generally has three sections; an "editor", a "spool" and a "history" section. - Editor Section ~~~~~~~~~~~~~~ @@ -1704,6 +1703,70 @@ describing the changed properties. As shown in the example, the editor template can use the ":note" and ":file" fields, which are added to the standard change note message generated by Roundup. +Form values +::::::::::: + +We have a number of ways to pull properties out of the form in order to +meet the various needs of: + +1. editing the current item (perhaps an issue item) +2. editing information related to the current item (eg. messages or + attached files) +3. creating new information to be linked to the current item (eg. time + spent on an issue) + +In the following, ```` values are variable, ":" may be +one of ":" or "@", and other text "required" is fixed. + +Properties are specified as form variables: + +```` + property on the current context item + +``:`` + property on the indicated item (for editing related information) + +``-:`` + property on the Nth new item of classname (generally for creating new + items to attach to the current item) + +Once we have determined the "propname", we check to see if it +is one of the special form values: + +``:required`` + The named property values must be supplied or a ValueError + will be raised. + +``:remove:=id(s)`` + The ids will be removed from the multilink property. + +``:add:=id(s)`` + The ids will be added to the multilink property. + +``:link:=`` + Used to add a link to new items created during edit. + These are collected up and returned in all_links. This will + result in an additional linking operation (either Link set or + Multilink append) after the edit/create is done using + all_props in _editnodes. The on the current item + will be set/appended the id of the newly created item of + class (where must be + -). + +Any of the form variables may be prefixed with a classname or +designator. + +Two special form values are supported for backwards +compatibility: + +``:note`` + create a message (with content, author and date), link + to the context item. This is ALWAYS desginated "msg-1". +``:file`` + create a file, attach to the current item and any + message created by :note. This is ALWAYS designated "file-1". + + Spool Section ~~~~~~~~~~~~~ diff --git a/doc/upgrading.txt b/doc/upgrading.txt index 742dabf..f01150c 100644 --- a/doc/upgrading.txt +++ b/doc/upgrading.txt @@ -13,13 +13,13 @@ 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:: +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" - the EMAIL_FROM_TAG goes inside the "Foo Bar" quotes like so:: +the EMAIL_FROM_TAG goes inside the "Foo Bar" quotes like so:: "Foo Bar EMAIL_FROM_TAG" @@ -34,43 +34,48 @@ one-size-fits-all, so it'll work even if you've added/removed detectors. 0.6.0 Form handling changes --------------------------- -XXX Form handling changed significantly! Document it! +Roundup's form handling capabilities have been significantly expanded. This +should not affect users of 0.5 installations - but if you find you're +getting errors from form submissions, please ask for help on the Roundup +users mailing list: -lose :multilink -name:confirm -> :confirm:name + http://lists.sourceforge.net/lists/listinfo/roundup-users + +See the customisation doc section on "Form Values" for documentation of the +new form variables possible. 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 tag:: +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 tag:: - 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. +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. - 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. +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 ----------------------------- +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:: +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(), @@ -80,41 +85,41 @@ name:confirm -> :confirm:name queries=Multilink('query'), roles=String(), timezone=String()) - And second - html interface. Add following lines to - $TRACKER_HOME/html/user.item template:: +And second - html interface. Add following lines to +$TRACKER_HOME/html/user.item template:: Timezone timezone - After that all users should be able to provide their timezone information. - Timezone should be a positive or negative integer - offset from GMT. +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. +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. +However you are not forced to make these modifications. By default roundup +will assume timezone=0 and will work as previous versions did. 0.6.0 Notes for metakit backend users ------------------------------------- -- Roundup 0.6.0 introduced searching on ranges of dates and intervals. To - support it, some modifications to interval storing routine were made. So if - your tracker uses metakit backend and your db schema contains intervals - property, searches on that property will not be accurate for db items that - was stored before roundup' upgrade. However all new records should be - searchable on intervals. +Roundup 0.6.0 introduced searching on ranges of dates and intervals. To +support it, some modifications to interval storing routine were made. So if +your tracker uses metakit backend and your db schema contains intervals +property, searches on that property will not be accurate for db items that +was stored before roundup' upgrade. However all new records should be +searchable on intervals. - It is possible to convert your database to new format: you can export and - import back all your data (consult "Migrating backends" in "Maintenance" - documentation). After this operation all your interval properties should - become searchable. +It is possible to convert your database to new format: you can export and +import back all your data (consult "Migrating backends" in "Maintenance" +documentation). After this operation all your interval properties should +become searchable. - Users of backends others than metakit should not worry about this issue. +Users of backends others than metakit should not worry about this issue. Migrating from 0.4.x to 0.5.0 diff --git a/roundup/cgi/client.py b/roundup/cgi/client.py index f85d695..7fae917 100644 --- a/roundup/cgi/client.py +++ b/roundup/cgi/client.py @@ -1,4 +1,4 @@ -# $Id: client.py,v 1.116 2003-05-09 03:32:41 richard Exp $ +# $Id: client.py,v 1.117 2003-05-09 04:04:27 richard Exp $ __doc__ = """ WWW request handler (also used in the stand-alone server). @@ -1434,10 +1434,12 @@ You should then receive another email with the new password. - property on the current context item : - - property on the indicated item + - property on the indicated item (for editing related + information) -: - - property on the Nth new item of classname + - property on the Nth new item of classname (generally for + creating new items to attach to the current item) Once we have determined the "propname", we check to see if it is one of the special form values: -- 2.30.2