Mercurial > p > roundup > code
diff doc/customizing.txt @ 3696:790363e96852
Sorting/grouping by multiple properties.
- Implement sorting/grouping by multiple properties for the web
interface. I'm now using @sort0/@sortdir0,@sort1/@sortdir1,... and
@group0/@groupdir0,... when generating URLs from a search template.
These are converted to a list internally. When saving URLs (e.g. when
storing queries) I'm using @sort=prop1,prop2,... and @group=... with
optional '-' prepended to individual props.
This means saved URLs are backward compatible with existing trackers
(and yes, this was a design goal).
I need the clumsy version with @sort0,@sort1 etc, because I'm
currently using several selectors and checkboxes (as the classic
template does, too). I don't think there is a way around that in HTML?
- Updated (hopefully all) documentation to reflect the new URL format
and the consequences in the web-interface.
- I've set the number of sort/group properties in the classic template
to two -- this can easily be reverted by changing n_sort to 1.
Richard, would you look over these changes? I've set a tag before and
(will set) after commit, so that it would be easy to merge out.
Don't be too scared about the size of the change, most is documentation,
the guts are in cgi/templating.py and small changes in the classic
template.
| author | Ralf Schlatterbeck <schlatterbeck@users.sourceforge.net> |
|---|---|
| date | Wed, 30 Aug 2006 20:28:26 +0000 |
| parents | 722ab52d47fc |
| children | af6eeba3a3f3 |
line wrap: on
line diff
--- a/doc/customizing.txt Wed Aug 30 09:35:31 2006 +0000 +++ b/doc/customizing.txt Wed Aug 30 20:28:26 2006 +0000 @@ -2,7 +2,7 @@ Customising Roundup =================== -:Version: $Revision: 1.205 $ +:Version: $Revision: 1.206 $ .. This document borrows from the ZopeBook section on ZPT. The original is at: http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx @@ -1865,7 +1865,8 @@ 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 + "group" are an optionally empty list ``[(dir, prop)]`` + where dir is '+', '-' or None and prop is a prop name or None. eg. ``issue.filter(filterspec={"priority": "1"}, @@ -2195,8 +2196,8 @@ columns dictionary of the columns to display in an index page show a convenience access to columns - request/show/colname will be true if the columns should be displayed, false otherwise -sort index sort column (direction, column name) -group index grouping property (direction, column name) +sort index sort columns [(direction, column name)] +group index grouping properties [(direction, column name)] filter properties to filter the index on filterspec values to filter the index on search_text text to perform a full-text search on for an index @@ -2432,7 +2433,7 @@ /issue?status=unread,in-progress,resolved& topic=security,ui& - @group=priority& + @group=priority,-status& @sort=-activity& @filters=status,topic& @columns=title,status,fixer @@ -2454,19 +2455,30 @@ The example specifies an index of "issue" items. Only items with a "status" of either "unread" or "in-progress" or "resolved" are displayed, and only items with "topic" values including both "security" -and "ui" are displayed. The items are grouped by priority, arranged in -ascending order; and within groups, sorted by activity, arranged in -descending order. The filter section shows filters for the "status" and -"topic" properties, and the table includes columns for the "title", -"status", and "fixer" properties. +and "ui" are displayed. The items are grouped by priority arranged in +ascending order and in descending order by status; and within +groups, sorted by activity, arranged in descending order. The filter +section shows filters for the "status" and "topic" properties, and the +table includes columns for the "title", "status", and "fixer" +properties. ============ ============================================================= Argument Description ============ ============================================================= @sort sort by prop name, optionally preceeded with '-' to give - descending or nothing for ascending sorting. + descending or nothing for ascending sorting. Several + properties can be specified delimited with comma. + Internally a search-page using several sort properties may + use @sort0, @sort1 etc. with option @sortdir0, @sortdir1 + etc. for the direction of sorting (a non-empty value of + sortdir0 specifies reverse order). @group group by prop name, optionally preceeded with '-' or to sort - in descending or nothing for ascending order. + in descending or nothing for ascending order. Several + properties can be specified delimited with comma. + Internally a search-page using several grouping properties may + use @group0, @group1 etc. with option @groupdir0, @groupdir1 + etc. for the direction of grouping (a non-empty value of + groupdir0 specifies reverse order). @columns selects the columns that should be displayed. Default is all. @filter indicates which properties are being used in filtering. @@ -3248,8 +3260,8 @@ </select> </td> <td><input type="checkbox" name=":columns" value="category"></td> - <td><input type="radio" name=":sort" value="category"></td> - <td><input type="radio" name=":group" value="category"></td> + <td><input type="radio" name=":sort0" value="category"></td> + <td><input type="radio" name=":group0" value="category"></td> </tr> Adding category to the default view