TicketQuery documentation improvement proposal
|Reported by:||AdrianFritz||Owned by:||AdrianFritz|
I believe this can improve a little bit TicketQuery documentation (rendered from source code found at http://trac.edgewall.org/browser/trunk/trac/ticket/query.py?rev=10750#L1178)
This macro accepts a comma-separated list of keyed parameters, in the form "key=value", as follws:
If the key is the name of a ticket field, the value must use the syntax of a filter specifier as defined in TracQuery#QueryLanguage.
- Note that this is not the same as the simplified URL syntax used for query: links starting with a ? character.
- Commas (,) can be included in field values by escaping them with a backslash (\).
The date keys
modified can also constrain the criteria. Again, see TracQuery#QueryLanguage.
In addition to filters, several other named parameters can be used to control how the results are presented. All of them are optional.
|Key||Description & Details||Default|
| Pipe-separated list of columns and its order to show (requires || |
| Reverse (|| |
| Sets how the list of tickets is displayed:|
|Sets the ticket field for grouping tickets.|| |
| Reverse (|| |
| Sets the limit number of tickets to display (|| |
|Sets the ticket field for ordering tickets.|| |
| Pipe-separated list of ticket fields to be viewed as a row, e.g. rows=description|summary (requires || |
| Get the description for the listed tickets (|| |
- Note 1
- For compatibility with Trac 0.10, if there's a last positional parameter given to the macro, it will be used to specify the format.
- Also, for compatibility with Trac 0.10, using "&" as a field separator still works (except for order) but is deprecated.
Change History (16)
comment:7 by , 8 years ago
|Milestone:||next-stable-1.0.x → 1.0|
|Status:||new → closed|
comment:11 by , 8 years ago
|Milestone:||1.0 → next-stable-1.0.x|
|Status:||closed → reopened|
comment:15 by , 6 years ago
|Release Notes:||modified (diff)|
|Status:||reopened → closed|