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: 0 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 175 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 11 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 5 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 251 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 680 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 1151 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 683 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 2818 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 0 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 7766 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 39 [[TicketQuery(reporter=$USER,or,owner=$USER,count)]]
Number of tickets created this month: 2 [[TicketQuery(created=thismonth..,count)]]
Number of closed Firefox tickets: 20 [[TicketQuery(status=closed,keywords~=firefox,count)]]
Number of closed Opera tickets: 16 [[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: 36 [[TicketQuery(status=closed,keywords~=firefox|opera,count)]]
Number of tickets that affect Firefox or are closed and affect Opera: 37 [[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: #15320, #15319, #15247 [[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
No tickets found

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:

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 7249)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#15312 notabug Date-picker wont stick with only month and/or year change AndreasRogall
Description

Changing the month or the Year and clicking outside the date-picker popup (or using TBA keyword stroke) doesn't change the Date entry field. ONLY if DAY is chosen as the last step everything sticks and the change is complete.

#15307 worksforme Option to show tabs when created Tyler Lazenby
Description

I would like to have a way to specify that the tab I create would be selected and its corresponding panel shown through something similar to

    tabs(
       create: "visible"
    );
#15301 duplicate Slider should provide a way to specify arbitrary scales teo1978
Description

I was looking at the documentation of the Slider plugin to see how you specify a scale that is not just linear between a minimum and a maximum, for example a set of contiguous intervals with different scales, or an interval with "gaps" (i.e. subitervals that cannot be selected), and to my astonishment I find out there isn't any support for such a thing whatsoever.

The ONLY kind of slider you can build is one with a linear scale, uniform between the minimum and the maximum. That's pathetic.

You should provide a way to specify a set of non-overlapping intervals (not necessarily contiguous), each with the initial and final value, each with the initial and final position of the handle in % of the total size of the slider, and optionally each with a different value of "step".

So one could build a slider that looks, for example, like this:

0--1--2--10--20--30--100--150--200

I'm really astonished that such a basic feature isn't already there. It's the bare minimum one would expect from a bloated plugin such as ui.slider.

Also it would be nice to have a built-in option for a logaritmic slider so one wouldn't have to build that from scratch.

1 2 3 4 5 6 7 8 9 10 11


See also: TracQuery, TracTickets, TracReports

Last modified 4 months ago Last modified on Jul 29, 2018, 7:32:16 PM