Index: openacs-4/packages/acs-templating/tcl/list-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/tcl/list-procs.tcl,v diff -u -r1.22 -r1.23 --- openacs-4/packages/acs-templating/tcl/list-procs.tcl 13 Jan 2005 13:56:00 -0000 1.22 +++ openacs-4/packages/acs-templating/tcl/list-procs.tcl 7 Feb 2005 10:30:33 -0000 1.23 @@ -197,10 +197,14 @@ @param filters Filters for the list. Typically used to slice the data, for example to see only rows by a particular user. Array-list of (filter-name, spec) pairs, like elements. Each spec, in turn, is an array-list of property-name/value pairs, where the value is 'subst'ed in the caller's environment, except for the *_eval properties, which are 'subst'ed in the multirow context. - In order for filters to work, you have to specify them in your page's ad_page_contract, typically as filter_name:optional. The list builder will find them from there, + In order for filters to work, you have to specify them in your page's ad_page_contract, typically as filter_name:optional. + The list builder will find them from there, by grabbing them from your page's local variables. See template::list::filter::create for details. + filters are also the mechanism to export state variables which need to be preserved. If for example you needed user_id to be + maintained for the filter and sorting links you would add -filters {user_id {}} + @param groupby Things you can group by, e.g. day, week, user, etc. Automatically creates a filter called 'groupby'. Single array-list of property-name/value pairs, where the value is 'subst'ed in the caller's environment. Groupby is really just a filter with a fixed name, so see above for more details.