TicketQuery Wiki Macro
The TicketQuery macro lets you display ticket information anywhere that accepts WikiFormatting.
The query language used by the [[TicketQuery]] macro is described in the TracQuery page.
Usage
[[TicketQuery]]
Wiki macro listing tickets that match certain criteria.
This macro accepts a comma-separated list of keyed parameters, in the form "key=value".
If the key is the name of a 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 (\).
Groups of field constraints to be OR-ed together can be separated by a
literal or argument.
In addition to filters, several other named parameters can be used to control how the results are presented. All of them are optional.
The format parameter determines how the list of tickets is
presented:
- list -- the default presentation is to list the ticket ID next to the summary, with each ticket on a separate line.
- compact -- the tickets are presented as a comma-separated list of ticket IDs.
- count -- only the count of matching tickets is displayed
- rawcount -- only the count of matching tickets is displayed, not even with a link to the corresponding query (since 1.1.1)
- table -- a view similar to the custom query view (but without the controls)
- progress -- a view similar to the milestone progress bars
The max parameter can be used to limit the number of tickets shown
(defaults to 0, i.e. no maximum).
The order parameter sets the field used for ordering tickets
(defaults to id).
The desc parameter indicates whether the order of the tickets
should be reversed (defaults to false).
The group parameter sets the field used for grouping tickets
(defaults to not being set).
The groupdesc parameter indicates whether the natural display
order of the groups should be reversed (defaults to false).
The verbose parameter can be set to a true value in order to
get the description for the listed tickets. For table format only.
deprecated in favor of the rows parameter
The rows parameter can be used to specify which field(s) should
be viewed as a row, e.g. rows=description|summary
The col parameter can be used to specify which fields should
be viewed as columns. For table format only.
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, using "&" as a field separator still works (except for order)
but is deprecated.
Examples
| Example | Result | Macro | |||||||
|---|---|---|---|---|---|---|---|---|---|
| Number of Triage tickets: | 12 | [[TicketQuery(status=new&milestone=,count)]]
| |||||||
| Number of new tickets: | 12 | [[TicketQuery(status=new,count)]]
| |||||||
| Number of reopened tickets: | 0 | [[TicketQuery(status=reopened,count)]]
| |||||||
| Number of assigned tickets: | 0 | [[TicketQuery(status=assigned,count)]]
| |||||||
| Number of invalid tickets: | 0 | [[TicketQuery(status=closed,resolution=invalid,count)]]
| |||||||
| Number of worksforme tickets: | 0 | [[TicketQuery(status=closed,resolution=worksforme,count)]]
| |||||||
| Number of duplicate tickets: | 0 | [[TicketQuery(status=closed,resolution=duplicate,count)]]
| |||||||
| Number of wontfix tickets: | 0 | [[TicketQuery(status=closed,resolution=wontfix,count)]]
| |||||||
| Number of fixed tickets: | 1 | [[TicketQuery(status=closed,resolution=fixed,count)]]
| |||||||
| Number of untriaged tickets (milestone unset): | 12 | [[TicketQuery(status!=closed,milestone=,count)]]
| |||||||
| Total number of tickets: | 13 | [[TicketQuery(count)]]
| |||||||
| Number of tickets reported or owned by current user: | 0 | [[TicketQuery(reporter=$USER,or,owner=$USER,count)]]
| |||||||
| Number of tickets created this month: | 0 | [[TicketQuery(created=thismonth..,count)]]
| |||||||
| Number of closed Firefox tickets: | 0 | [[TicketQuery(status=closed,keywords~=firefox,count)]]
| |||||||
| Number of closed Opera tickets: | 0 | [[TicketQuery(status=closed,keywords~=opera,count)]]
| |||||||
| Number of closed tickets affecting Firefox and Opera: | 0 | [[TicketQuery(status=closed,keywords~=firefox opera,count)]]
| |||||||
| Number of closed tickets affecting Firefox or Opera: | 0 | [[TicketQuery(status=closed,keywords~=firefox|opera,count)]]
| |||||||
| Number of tickets that affect Firefox or are closed and affect Opera: | 0 | [[TicketQuery(status=closed,keywords~=opera,or,keywords~=firefox,count)]]
| |||||||
| Number of closed Firefox tickets that don't affect Opera: | 0 | [[TicketQuery(status=closed,keywords~=firefox -opera,count)]]
| |||||||
| Last 3 modified tickets: | #1, #13, #12 | [[TicketQuery(max=3,order=modified,desc=1,compact)]]
| |||||||
Details of ticket #1: |
| ||||||||
| |||||||||
Format: list
[[TicketQuery(version=0.6|0.7&resolution=duplicate)]]
This is displayed as:
No results
[[TicketQuery(id=123)]]
This is displayed as:
No results
Format: compact
[[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
This is displayed as:
No results
Format: count
[[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]
This is displayed as:
Format: progress
[[TicketQuery(milestone=0.12.8&group=type,format=progress)]]
This is displayed as:
Format: table
You can choose the columns displayed in the table format (format=table) using col=<field>. You can specify multiple fields and the order they are displayed in by placing pipes (|) between the columns:
[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]
This is displayed as:
| Ticket | Resolution | Summary | Owner | Reporter |
|---|---|---|---|---|
| #1 | fixed | Bug in handling of delimiter/completion gestures in McCLIM input editing |
Full rows
In table format you can specify full rows using rows=<field>:
[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]]
This is displayed as:
| Ticket | Resolution | Summary | Owner | Reporter |
|---|---|---|---|---|
| #1 | fixed | Bug in handling of delimiter/completion gestures in McCLIM input editing | ||
| Description |
Observe the following presentation type definition: (in-package :clim-user)
(define-presentation-type unacceptable ())
(define-presentation-method accept
((type unacceptable) stream view &key)
(with-delimiter-gestures (#\Space)
(list (accept 'package :stream stream :view view :prompt nil)
(accept 'package :stream stream :view view :prompt nil))))
Using Drei, doing (accept 'unacceptable) will work while accepting the first package, but when you press space to accept the second one, a debugger will pop up and inform you that you did not provide any input, and that there is not a default value. I think the problem is that the delimiter gesture is "re-evaluated" as a terminating delimiter gesture. The problem does not show up with Goatee, because Goatee implements a non-standard hack with which you can inhabit rescanning by providing :rescan nil as argument to replace-input. This is used in the completion done when pressing space after entering the first package name. I don't think the McCLIM input editing routines should expect input-editing-streams to implement nonstandard hacks in order to work properly, but I haven't yet been able to figure out how to fix this. In case anyone is interested, I think the buggy function is complete-input. At least, that's where the replace-input-call is. This is a very serious problem that prevents Drei from being able to accept many interesting presentation types, including some seen in classic CLIM applications. |
|||
See also: TracQuery, TracTickets, TracReports
