Edgewall Software

Version 20 (modified by Ryan J Ollos, 23 months ago) ( diff )

Content moved from TracQuery@56.

This page documents the 1.4 (latest stable) release. Documentation for other releases can be found here.

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.



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.


Example Result Macro
Number of Triage tickets: 22 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 1046 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 4 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 29 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 1509 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1406 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 2176 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 980 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 4445 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 25 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 12169 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 1821 [[TicketQuery(reporter=$USER,or,owner=$USER,count)]]
Number of tickets created this month: 22 [[TicketQuery(created=thismonth..,count)]]
Number of closed Firefox tickets: 13 [[TicketQuery(status=closed,keywords~=firefox,count)]]
Number of closed Opera tickets: 12 [[TicketQuery(status=closed,keywords~=opera,count)]]
Number of closed tickets affecting Firefox and Opera: 1 [[TicketQuery(status=closed,keywords~=firefox opera,count)]]
Number of closed tickets affecting Firefox or Opera: 24 [[TicketQuery(status=closed,keywords~=firefox|opera,count)]]
Number of tickets that affect Firefox or are closed and affect Opera: 25 [[TicketQuery(status=closed,keywords~=opera,or,keywords~=firefox,count)]]
Number of closed Firefox tickets that don't affect Opera: 1 [[TicketQuery(status=closed,keywords~=firefox -opera,count)]]
Last 3 modified tickets: #13205, #13271, #13195 [[TicketQuery(max=3,order=modified,desc=1,compact)]]

Details of ticket #1:


Ticket Owner Reporter
#1 anonymous
Summary Add a new project summary module.

Format: list


This is displayed as:

Wiki preview injects new lines
request for colour legend (or something similar) for ticket groups in reports
Ticket Dependencies
Link to diff of specifik wiki change instead of the page itself
All ticket modifications should be tracked in timeline
Installing on Windows, drive other than C:
Diffviewer should try to convert the text into utf-8.
merging of similar tickets
Python process sometimes hangs on Windows Server 2003
IE 5-6 over HTTPS broken downloads


This is displayed as:

No SQL error display

Format: compact

[[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]

This is displayed as:

#181, #204, #226, #239, #351, #413, #450, #475, #519, #529

Format: count

[[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]

This is displayed as:


Format: progress


This is displayed as:


5 / 5


2 / 2

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:


This is displayed as:

Results (1 - 3 of 11090)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#13303 fixed Move prefs panel help to bottom of page Ryan J Ollos Ryan J Ollos
#13300 fixed Use TicketFieldList in ticket templates and remove fields_map Ryan J Ollos Ryan J Ollos
#13298 fixed Autopreview triggers without a form change Ryan J Ollos Ryan J Ollos
1 2 3 4 5 6 7 8 9 10 11

Full rows

In table format you can specify full rows using rows=<field>:


This is displayed as:

Results (1 - 3 of 11090)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#13303 fixed Move prefs panel help to bottom of page Ryan J Ollos Ryan J Ollos

Found while investigating #1660. This places the help below child panels.

Also, I think we can have /prefs/notification use the default submit button.

#13300 fixed Use TicketFieldList in ticket templates and remove fields_map Ryan J Ollos Ryan J Ollos

We can deprecate fields_map on 1.4-stable and refactor to use fields in the template if fields is an instance of TicketFieldList (from trac.ticket.api).

#13298 fixed Autopreview triggers without a form change Ryan J Ollos Ryan J Ollos

To reproduce:

  • Navigate to New Ticket. The Summary field will have focus.
  • Open a select box or put the focus on another element. Autopreview will trigger.

Screen Recording 2020-05-16 at 15.25.51 480p.mov

The problem is due to two changes:

  • In r13452 the workflow controls were added to the new ticket page. We added the create and assign action, which includes a select box for assigning the owner.
  • In r13707 the ticket_workflow.html template was added and the associated JavaScript was moved into this template. The JavaScript disables workflow inputs associated with actions that are not selected, such as the create and assign assign-to field. Since jQuery ready handlers executed in the order they are added, this JavaScript executes after autoSubmit initializes.

With the default workflow, create action will be selected when loading the New Ticket page.

The autoSubmit will initialize and collect a list of all inputs which will includes the #action_create_and_assign_reassign_owner select. After that happens, the #action_create_and_assign_reassign_owner select will be disabled.

Any of the events input cut paste keydown keypress change blur will trigger the autopreview, because the new array of form elements will be one-less in length than that which was originally stored (the one-less is the absence of the #action_create_and_assign_reassign_owner element.

I tried to solve this in several ways. First, by executing the JavaScript in ticket_workflow.html immediately after the elements are created rather than adding a document ready handler. This results in a flicker in which the element is shown for milliseconds without being disabled. Then, I tried hiding the entire form element until the JavaScript is executed, but it makes for complex code.

Another option would be to move the script block in ticket.html to the end of the page, so that the document ready handler is positioned after the one in ticket_workflow.html.

There appears to be a simpler solution. It looks like we can just initialize values on the first trigger, because we trigger on element losing focus (blur) as well as keydown, and values gets initialized before any elements of the form are changed.

  • trac/htdocs/js/auto_preview.js

    diff --git a/trac/htdocs/js/auto_preview.js b/trac/htdocs/js/auto_preview.js
    index a1dfd1bd9..e6e5f31bb 100644
    a b  
    2828    var timer = null;
    2929    var updating = false;
    3030    var queued = false;
     31    var values = null;
    3233    // Return true iff the values have changed
    3334    function values_changed(new_values) {
    8283    // Trigger a request after the given timeout
    8384    function trigger() {
     85      if (values === null)
     86        values = form.serializeArray();
    8487      if (!updating) {
    8588        if (timer)
    8689          clearTimeout(timer);
    9194      return true;
    9295    }
    94     var values = form.serializeArray();
    9597    // See #11510
    9698    return inputs.bind('input cut paste keydown keypress change blur',
    9799                       trigger);
1 2 3 4 5 6 7 8 9 10 11

See also: TracQuery, TracTickets, TracReports, TracGuide

Note: See TracWiki for help on using the wiki.