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:	11	[[TicketQuery(status=new&milestone=,count)]]
Number of new tickets:	11	[[TicketQuery(status=new,count)]]
Number of reopened tickets:	0	[[TicketQuery(status=reopened,count)]]
Number of assigned tickets:	1	[[TicketQuery(status=assigned,count)]]
Number of invalid tickets:	0	[[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets:	4	[[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets:	1	[[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets:	1	[[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets:	9	[[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset):	13	[[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets:	28	[[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:	#23, #1, #17	[[TicketQuery(max=3,order=modified,desc=1,compact)]]
Details of ticket #1:		[[TicketQuery(id=1,col=id|owner|reporter,rows=summary,table)]]
Ticket Owner Reporter #1 cinc criguada@… Summary Object hint orphaned when closing a folder while the hint is showing

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:

0

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:

Results (1 - 3 of 15)

1 2 3 4 5 →

Ticket	Resolution	Summary	Owner	Reporter
#23	fixed	Lost focus of details window	cinc	guest
#21	worksforme	window display hesitates when moved across edge of another window	somebody	guest
#19	fixed	Trap cwfolder.c, around line 276 while calling function #12.	cinc	guest

1 2 3 4 5 →

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:

Results (1 - 3 of 15)

1 2 3 4 5 →

Ticket	Resolution	Summary	Owner	Reporter
#23	fixed	Lost focus of details window	cinc	guest
Description	I installed wpswizard-0_6_1a3 (just the dlls). When I open specific drives (details view) and select properties everything works fine. When I close the properties the original drive window never gets focus again. Requires a desktop restart to close window. MikeG
#21	worksforme	window display hesitates when moved across edge of another window	somebody	guest
Description	When moving a window across the boundary of another window the display hesitates. This happens most of the time but not always. I use SNAP 3.1.8 with a ATI 9250 card on a SMP P4 eCS 2.0 system. The CPU meter does not show a large load when the movement hesitates. There is no good way to explain this situation so I have used a camcorder to take a shot of the screen. The result is a MPG2 video (112meg) downloadable here: ​http://www.mgreene.org/xfer/wpswiz.zip This issue almost wakes WPS-Wizard unusable on this system.
#19	fixed	Trap cwfolder.c, around line 276 while calling function #12.	cinc	guest
Description	I installed WPSWizard V0.6.0 and updated with 6.1.a1, I get these in the log file: Thread slot 79 , Id 1 , priority 0x200 Stack Bottom : 073A1000 (073A:1000) ;Stack Top : 074A0000 (074A:0000) Process Id : 52 .EXE name : C:\OS2\PMSHELL.EXE Trap occured in do_funcWithNewStack, file c/c_class/cwfolder.c, around line 276 while calling function #12. A trap occurred in WPS-Wizard Exception C0000005 Occurred at Sat Feb 16 21:21:55 2008 Invalid read address 00000000 OS/2 Version 2.45 Failing code module internal name : WPSWIZZ Failing code module file name : C:\WPSWIZARD\WPSWIZZ.DLL Failing code Object # 1 at Offset 13e7a File Line# Public Symbol ──────────── ────- ────────────- N/A N/A No auto variables found in . I have attached the log file. MikeG

1 2 3 4 5 →

---

See also: TracQuery, TracTickets, TracReports