Mercurial > p > roundup > code
comparison doc/user_guide.txt @ 3036:8fa6b5747a53
updated searching / indexing docs
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Mon, 03 Jan 2005 22:55:09 +0000 |
| parents | 5c0e5abcb5e3 |
| children | 4fd84dcfed33 |
comparison
equal
deleted
inserted
replaced
| 3033:f8d0fd056ac0 | 3036:8fa6b5747a53 |
|---|---|
| 1 ========== | 1 ========== |
| 2 User Guide | 2 User Guide |
| 3 ========== | 3 ========== |
| 4 | 4 |
| 5 :Version: $Revision: 1.30 $ | 5 :Version: $Revision: 1.31 $ |
| 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 |
| 307 ~~~~~~~~~~~~~~~~ | 307 ~~~~~~~~~~~~~~~~ |
| 308 | 308 |
| 309 The searching page converts your selections into the following | 309 The searching page converts your selections into the following |
| 310 arguments: | 310 arguments: |
| 311 | 311 |
| 312 ========== ============================================================= | 312 ============ ============================================================= |
| 313 Argument Description | 313 Argument Description |
| 314 ========== ============================================================= | 314 ============ ============================================================= |
| 315 :sort sort by prop name, optionally preceeded with '-' to give | 315 @sort sort by prop name, optionally preceeded with '-' to give |
| 316 descending or nothing for ascending sorting. | 316 descending or nothing for ascending sorting. |
| 317 :group group by prop name, optionally preceeded with '-' or to sort | 317 @group group by prop name, optionally preceeded with '-' or to sort |
| 318 in descending or nothing for ascending order. | 318 in descending or nothing for ascending order. |
| 319 :filter selects which props should be displayed in the filter | 319 @columns selects the columns that should be displayed. Default is |
| 320 section. Default is all. | 320 all. |
| 321 :columns selects the columns that should be displayed. Default is | 321 @filter indicates which properties are being used in filtering. |
| 322 all. | 322 Default is none. |
| 323 propname selects the values the item properties given by propname must | 323 propname selects the values the item properties given by propname must |
| 324 have (very basic search/filter). | 324 have (very basic search/filter). |
| 325 ========== ============================================================= | 325 @search_text performs a full-text search (message bodies, issue titles, |
| 326 etc) | |
| 327 ============ ============================================================= | |
| 326 | 328 |
| 327 You may manually write URLS that contain these arguments, like so | 329 You may manually write URLS that contain these arguments, like so |
| 328 (whitespace has been added for clarity):: | 330 (whitespace has been added for clarity):: |
| 329 | 331 |
| 330 /issue?status=unread,in-progress,resolved& | 332 /issue?status=unread,in-progress,resolved& |
| 331 topic=security,ui& | 333 topic=security,ui& |
| 332 :group=priority& | 334 @group=priority& |
| 333 :sort=-activity& | 335 @sort=-activity& |
| 334 :filters=status,topic& | 336 @filters=status,topic& |
| 335 :columns=title,status,fixer | 337 @columns=title,status,fixer |
| 336 | 338 |
| 337 | 339 |
| 338 Access Controls | 340 Access Controls |
| 339 --------------- | 341 --------------- |
| 340 | 342 |