diff roundup/cgi/templating.py @ 3127:021b131bd816

doc fixes, one more fix to the permissions-in-listings fix
author Richard Jones <richard@users.sourceforge.net>
date Fri, 11 Feb 2005 22:18:20 +0000
parents a2889d22db4a
children 6feac4fcf883
line wrap: on
line diff
--- a/roundup/cgi/templating.py	Fri Feb 04 05:25:50 2005 +0000
+++ b/roundup/cgi/templating.py	Fri Feb 11 22:18:20 2005 +0000
@@ -1596,6 +1596,18 @@
             sort_on=None, **conditions):
         ''' Render a form select list for this property
 
+            "size" is used to limit the length of the list labels
+            "height" is used to set the <select> tag's "size" attribute
+            "showid" includes the item ids in the list labels
+            "additional" lists properties which should be included in the
+                label
+            "sort_on" indicates the property to sort the list on as
+                (direction, property) where direction is '+' or '-'.
+            
+            The remaining keyword arguments are used as conditions for
+            filtering the items in the list - they're passed as the
+            "filterspec" argument to a Class.filter() call.
+
             If not editable, just display the value via plain().
         '''
         if not self.is_edit_ok():
@@ -1764,7 +1776,19 @@
 
     def menu(self, size=None, height=None, showid=0, additional=[],
             sort_on=None, **conditions):
-        ''' Render a form select list for this property
+        ''' Render a form <select> list for this property.
+
+            "size" is used to limit the length of the list labels
+            "height" is used to set the <select> tag's "size" attribute
+            "showid" includes the item ids in the list labels
+            "additional" lists properties which should be included in the
+                label
+            "sort_on" indicates the property to sort the list on as
+                (direction, property) where direction is '+' or '-'.
+            
+            The remaining keyword arguments are used as conditions for
+            filtering the items in the list - they're passed as the
+            "filterspec" argument to a Class.filter() call.
 
             If not editable, just display the value via plain().
         '''

Roundup Issue Tracker: http://roundup-tracker.org/