Mercurial Repository: p/roundup/code: doc/customizing.txt comparison

comparison doc/customizing.txt @ 1406:ca7dfc8bce15

fixes to time tracking customisation

author	Richard Jones <richard@users.sourceforge.net>
date	Sun, 02 Feb 2003 23:59:48 +0000
parents	8e4c3e8de96f
children	8dc60d87ab42

comparison

equal deleted inserted replaced

-:2158bdbcac37
+:ca7dfc8bce15
 ===================
 Customising Roundup
 ===================
-:Version: $Revision: 1.71 $
+:Version: $Revision: 1.72 $
 .. This document borrows from the ZopeBook section on ZPT. The original is at:
 http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
 .. contents::
 2. fake that the issue's "times" property has been edited, and then
 3. call the normal CGI edit action handler.
 The code to do this is::
-actions = client.Client.actions + (
+class Client(client.Client):
-('edit_with_timelog', 'timelogEditAction'),
+''' derives basic CGI implementation from the standard module,
-)
+with any specific extensions
+'''
-def timelogEditAction(self):
+actions = client.Client.actions + (
-''' Handle the creation of a new time log entry if necessary.
+('edit_with_timelog', 'timelogEditAction'),
+)
-If we create a new entry, fake up a CGI form value for the altered
-"times" property of the issue being edited.
+def timelogEditAction(self):
+''' Handle the creation of a new time log entry if necessary.
-Punt to the regular edit action when we're done.
-'''
+If we create a new entry, fake up a CGI form value for the
-# if there's a timelog value specified, create an entry
+altered "times" property of the issue being edited.
-if self.form.has_key(':timelog') and \
-self.form[':timelog'].value.strip():
+Punt to the regular edit action when we're done.
-period = Interval(self.form[':timelog'].value)
+'''
-# create it
+# if there's a timelog value specified, create an entry
-newid = self.db.timelog.create(period=period)
+if self.form.has_key(':timelog') and \
+self.form[':timelog'].value.strip():
-# if we're editing an existing item, get the old timelog value
+period = Interval(self.form[':timelog'].value)
-if self.nodeid:
+# create it
-l = self.db.issue.get(self.nodeid, 'times')
+newid = self.db.timelog.create(period=period)
-l.append(newid)
-else:
+# if we're editing an existing item, get the old timelog value
-l = [newid]
+if self.nodeid:
+l = self.db.issue.get(self.nodeid, 'times')
-# now make the fake CGI form values
+l.append(newid)
-for entry in l:
+else:
-self.form.list.append(MiniFieldStorage('times', entry))
+l = [newid]
-# punt to the normal edit action
+# now make the fake CGI form values
-return self.editItemAction()
+for entry in l:
+self.form.list.append(MiniFieldStorage('times', entry))
+# punt to the normal edit action
+return self.editItemAction()
 you add this code to your Client class in your tracker's ``interfaces.py``
-file.
+file. Locate the section that looks like::
+class Client:
+''' derives basic CGI implementation from the standard module,
+with any specific extensions
+'''
+pass
+and insert this code in place of the ``pass`` statement.
 5. You'll also need to modify your ``issue.item`` form submit action so it
-calls the time logging action we just created::
+calls the time logging action we just created. The current template will
+look like this::
+<tr>
+<td>&nbsp;</td>
+<td colspan=3 tal:content="structure context/submit">
+submit button will go here
+</td>
+</tr>
+replace it with this::
 <tr>
 <td>&nbsp;</td>
 <td colspan=3>
 <tal:block tal:condition="context/id">
 <input type="submit" name="submit" value="Submit New Issue">
 </tal:block>
 </td>
 </tr>
-Note that the "context/submit" command usually handles all that for you -
+The important change is setting the action to "edit_with_timelog" for
-isn't it handy? The important change is setting the action to
+edit operations (where the item exists)
-"edit_with_timelog" for edit operations (where the item exists)
 6. We want to display a total of the time log times that have been accumulated
 for an issue. To do this, we'll need to actually write some Python code,
 since it's beyond the scope of PageTemplates to perform such calculations.
 We do this by adding a method to the TemplatingUtils class in our tracker
 ``interfaces.py`` module::
 class TemplatingUtils:
 ''' Methods implemented on this class will be available to HTML
 templates through the 'utils' variable.
 '''
 total = Interval('')
 for time in times:
 total += time.period._value
 return total
+Replace the ``pass`` line as we did in step 4 above with the Client class.
 As indicated in the docstrings, we will be able to access the
-``totalTimeSpent`` method via the ``utils`` variable in our templates. See
+``totalTimeSpent`` method via the ``utils`` variable in our templates.
 7. Display the time log for an issue::
 <table class="otherinfo" tal:condition="context/times">
 <tr><th colspan="3" class="header">Time Log

Mercurial > p > roundup > code

comparison doc/customizing.txt @ 1406:ca7dfc8bce15