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:	2	[[TicketQuery(status=new&milestone=,count)]]
Number of new tickets:	2	[[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:	1	[[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:	2	[[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset):	2	[[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets:	5	[[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:	#5, #4, #3	[[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 Alfredo Fernández Díaz Summary Binaries and sources newer than 2009 not available

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 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
#5	fixed	Italian boot menu renders incorrectly		lewisr
#4	fixed	menu.brn driver string is malformed in certain cases		lewisr
#3	invalid	genproto has difficulty parsing some NIFs		lewisr

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
#5	fixed	Italian boot menu renders incorrectly		lewisr
Description	Although there were no textual changes between 2019.08.08 and 2021.08.12, the rendering of the opening boot menus is broken in the later build. See screenshots, attached.
#4	fixed	menu.brn driver string is malformed in certain cases		lewisr
Description	There seems to be some discrepancy between the length defined for a given driver description and driver name and how the string is interpreted when placed into the defined variable. Example: Given the following CONFIG.SYS statement to be completed: DEVICE=\^DEV_CDROM:********^.DMD^MISC_PROB_VERBOSE:false: /Q^^MISC_PROB_VERBOSE:true: /V^ The following strings all work: ; *note: Driver name *must* always be in brackets at the end of the string ; ; max. length: >1234567890123456789012345678901234567890123< '<DEV_CDROM_LIST_DEFAULT>' = 'Standard CD/DVD-Gerätemanager (OS2CDROM)' '<DEV_CDROM_LIST_01>' = 'Standard CD/DVD-Gerätemanager (OS2CDROM)' '<DEV_CDROM_LIST_02>' = 'Erweiterter CD/DVD-Gerätemanager (JJSCDROM)' '<DEV_CDROM_LIST_03>' = 'Legacy CD-Gerätemanager (OLDCDROM)' whereas results from these strings are inconsistent: ; *note: Driver name *must* always be in brackets at the end of the string ; ; max. length: >1234567890123456789012345678901234567890123< '<DEV_CDROM_LIST_DEFAULT>' = 'Standard CD/DVD Geräte-Manager (OS2CDROM)' '<DEV_CDROM_LIST_01>' = 'Standard CD/DVD Geräte-Manager (OS2CDROM)' '<DEV_CDROM_LIST_02>' = 'Erweiterter CD/DVD Ger.-Manager (JJSCDROM)' '<DEV_CDROM_LIST_03>' = 'Alter CD-Geräte-Manager (OLDCDROM)' In the latter case, 'Standard CD/DVD Geräte-Manager (OS2CDROM)' results in <DEV_CDROM_LIST_01> being placed into CONFIG.SYS as: \S2CDROM).DMD The same corruption is seen for <DEV_CDROM_LIST_02>, which ends up as: \JSCDROM).DMD Yet, <DEV_CDROM_LIST_03>, (with greater padding?) is properly entered. However, by adding (back) the extra spaces: ; *note: Driver name *must* always be in brackets at the end of the string ; ; max. length: >1234567890123456789012345678901234567890123< '<DEV_CDROM_LIST_DEFAULT>' = 'Standard CD/DVD Geräte-Manager (OS2CDROM)' '<DEV_CDROM_LIST_01>' = 'Standard CD/DVD Geräte-Manager (OS2CDROM)' '<DEV_CDROM_LIST_02>' = 'Erweiterter CD/DVD Ger.-Manager (JJSCDROM)' '<DEV_CDROM_LIST_03>' = 'Alter CD-Geräte-Manager (OLDCDROM)' all variables are properly filled. I haven't seen this anywhere else, yet, nor have I tested without the umlauts.
#3	invalid	genproto has difficulty parsing some NIFs		lewisr
Description	While installing ArcaOS on Hawking, I was forced to use the Compaq-supplied B57 NIC driver (neither the MMBGE nor the Broadcom reference driver work correctly on that hardware). During boot, GENPROTO complained about the duplex setting in the NIF: Nif-parser: B57.nif#58: String "HALF" is longer that allowed StrLength. This comes from GENPROTO.PAS. For its part of the incident, the NIF actually says: [Duplex] tag = DUPLEX display = "Duplex Mode" type = string strlength = 3 set = HALF,FULL optional = YES editable = YES help = "This parameter specifies duplex mode on the ethernet controller. This parameter is optional unless the Linespeed parameter is specified. The Linespeed parameter must be set when this keyword is used. If neither the Duplex nor the Linespeed paramaters are specified the ethernet controller will default to autonegotiate mode." (including the misspelling of "parameters" in the last sentence)

---

See also: TracQuery, TracTickets, TracReports