diff doc/customizing.txt @ 2858:0357a9c93933

fix filter() doc
author Richard Jones <richard@users.sourceforge.net>
date Wed, 03 Nov 2004 03:07:04 +0000
parents 874bf6abad42
children 1ca5ebe9b16a
line wrap: on
line diff
--- a/doc/customizing.txt	Wed Nov 03 01:34:21 2004 +0000
+++ b/doc/customizing.txt	Wed Nov 03 03:07:04 2004 +0000
@@ -2,7 +2,7 @@
 Customising Roundup
 ===================
 
-:Version: $Revision: 1.148 $
+:Version: $Revision: 1.149 $
 
 .. This document borrows from the ZopeBook section on ZPT. The original is at:
    http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
@@ -1679,8 +1679,18 @@
 list        lists all of the active (not retired) items in the class.
 csv         return the items of this class as a chunk of CSV text.
 propnames   lists the names of the properties of this class.
-filter      lists of items from this class, filtered and sorted by the
-            current *request* filterspec/filter/sort/group args
+filter      lists of items from this class, filtered and sorted. Two
+            options are avaible for sorting:
+
+            1. by the current *request* filterspec/filter/sort/group args
+            2. by the "filterspec", "sort" and "group" keyword args.
+               "filterspec" is ``{propname: value(s)}``. "sort" and
+               "group" are ``(dir, prop)`` where dir is '+', '-' or None
+               and prop is a prop name or None.
+
+            eg. ``issue.filter(filterspec={"priority": "1"},
+            sort=('activity', '+'))``
+
 classhelp   display a link to a javascript popup containing this class'
             "help" template.
 submit      generate a submit button (and action hidden element)

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