comparison doc/user_guide.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 77e067e64035
children 9f4dd27ae843
comparison
equal deleted inserted replaced
3695:01ea89743311 3696:790363e96852
1 ========== 1 ==========
2 User Guide 2 User Guide
3 ========== 3 ==========
4 4
5 :Version: $Revision: 1.33 $ 5 :Version: $Revision: 1.34 $
6 6
7 .. contents:: 7 .. contents::
8 8
9 .. hint:: 9 .. hint::
10 This document will refer to *issues* as the primary store of 10 This document will refer to *issues* as the primary store of
336 336
337 ============ ============================================================= 337 ============ =============================================================
338 Argument Description 338 Argument Description
339 ============ ============================================================= 339 ============ =============================================================
340 @sort sort by prop name, optionally preceeded with '-' to give 340 @sort sort by prop name, optionally preceeded with '-' to give
341 descending or nothing for ascending sorting. 341 descending or nothing for ascending sorting. The sort
342 argument can have several props separated with comma.
342 @group group by prop name, optionally preceeded with '-' or to sort 343 @group group by prop name, optionally preceeded with '-' or to sort
343 in descending or nothing for ascending order. 344 in descending or nothing for ascending order. The group
345 argument can have several props separated with comma.
344 @columns selects the columns that should be displayed. Default is 346 @columns selects the columns that should be displayed. Default is
345 all. 347 all.
346 @filter indicates which properties are being used in filtering. 348 @filter indicates which properties are being used in filtering.
347 Default is none. 349 Default is none.
348 propname selects the values the item properties given by propname must 350 propname selects the values the item properties given by propname must
354 You may manually write URLS that contain these arguments, like so 356 You may manually write URLS that contain these arguments, like so
355 (whitespace has been added for clarity):: 357 (whitespace has been added for clarity)::
356 358
357 /issue?status=unread,in-progress,resolved& 359 /issue?status=unread,in-progress,resolved&
358 topic=security,ui& 360 topic=security,ui&
359 @group=priority& 361 @group=priority,-status&
360 @sort=-activity& 362 @sort=-activity&
361 @filters=status,topic& 363 @filters=status,topic&
362 @columns=title,status,fixer 364 @columns=title,status,fixer
363 365
364 366

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