diff doc/customizing.txt @ 3363:7bc1e9c42a26

allow specification of pagesize, sorting and filtering in "classhelp" popups [SF#1211800]
author Richard Jones <richard@users.sourceforge.net>
date Fri, 24 Jun 2005 06:27:45 +0000
parents 8897483a9f8b
children 7d48c5b1e8f2
line wrap: on
line diff
--- a/doc/customizing.txt	Fri Jun 24 05:42:21 2005 +0000
+++ b/doc/customizing.txt	Fri Jun 24 06:27:45 2005 +0000
@@ -2,7 +2,7 @@
 Customising Roundup
 ===================
 
-:Version: $Revision: 1.181 $
+:Version: $Revision: 1.182 $
 
 .. This document borrows from the ZopeBook section on ZPT. The original is at:
    http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
@@ -1764,6 +1764,32 @@
 
 classhelp   display a link to a javascript popup containing this class'
             "help" template.
+
+            This generates a link to a popup window which displays the
+            properties indicated by "properties" of the class named by
+            "classname". The "properties" should be a comma-separated list
+            (eg. 'id,name,description'). Properties defaults to all the
+            properties of a class (excluding id, creator, created and
+            activity).
+
+            You may optionally override the "label" displayed, the "width",
+            the "height", the number of items per page ("pagesize") and
+            the field on which the list is sorted ("sort").
+
+            With the "filter" arg it is possible to specify a filter for
+            which items are supposed to be displayed. It has to be of
+            the format "<field>=<values>;<field>=<values>;...".
+
+            The popup window will be resizable and scrollable.
+
+            If the "property" arg is given, it's passed through to the
+            javascript help_window function. This allows updating of a
+            property in the calling HTML page.
+
+            If the "form" arg is given, it's passed through to the
+            javascript help_window function - it's the name of the form
+            the "property" belongs to.
+
 submit      generate a submit button (and action hidden element)
 renderWith  render this class with the given template.
 history     returns 'New node - no history' :)
@@ -1953,7 +1979,9 @@
                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 '-'.
+                (direction, property) where direction is '+' or '-'. A
+                single string with the direction prepended may be used.
+                For example: ('-', 'order'), '+name'.
 
             The remaining keyword arguments are used as conditions for
             filtering the items in the list - they're passed as the

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