Edgewall Software

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.

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: 22 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 1045 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 4 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 24 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 1509 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1408 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 2176 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 981 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 4464 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 25 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 12185 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 1825 [[TicketQuery(reporter=$USER,or,owner=$USER,count)]]
Number of tickets created this month: 0 [[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: #13318, #13321, #12129 [[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 anonymous
Summary Add a new project summary module.

Format: list

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

This is displayed as:

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

[[TicketQuery(id=123)]]

This is displayed as:

#123
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:

10

Format: progress

[[TicketQuery(milestone=0.12.8&group=type,format=progress)]]

This is displayed as:

defect

5 / 5

enhancement

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:

[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]

This is displayed as:

Results (1 - 3 of 11112)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#13320 fixed Environment Type Parsing Fails Due to Carriage Return Ryan J Ollos anonymous
#13319 fixed Refactor .travis.yml Ryan J Ollos Ryan J Ollos
#13317 fixed Autopreview triggers only on second change (Regression after #13298) Ryan J Ollos Cinc-th
1 2 3 4 5 6 7 8 9 10 11

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#13320 fixed Environment Type Parsing Fails Due to Carriage Return Ryan J Ollos anonymous
Description

Attempting to upgrade an old Trac 0.12 installation from Apache on Windows to Apache on WSL (Ubuntu 20.04).

The environment version check did not strip the carriage return, therefore generating the error

Unknown Trac environment type 'Trac Environment Version 1

Adding the strip for the carriage return in env.py fixed the problem. (There may be a more elegant way, but this worked.)

    def verify(self):
        """Verify that the provided path points to a valid Trac environment
        directory."""
        try:
            with open(os.path.join(self.path, 'VERSION')) as f:
                tag = f.readline().rstrip('\n').rstrip('\r')
#13319 fixed Refactor .travis.yml Ryan J Ollos Ryan J Ollos
Description

Group database setup operations and move to before_script stage phase since the operations don't need to run for deploy.

#13317 fixed Autopreview triggers only on second change (Regression after #13298) Ryan J Ollos Cinc-th
Description

The change in #13298 causes the following regression.

When using the autoSubmit() function in a custom script on the newticket page (see file refresh_actions.js in th:wiki/MultipleWorkflowPlugin) a request is only sent on second change of the select control with the attached autoSubmit handler.

This is because

  • on the first change the variable values is null and will be initialized in trigger() with the current form data (this is after the change already happened)
        // Trigger a request after the given timeout
       function trigger() {
         if (values === null)
           values = form.serializeArray();
           ...    
       }
    
  • in request() called after the timeout the form is again serialized into variable new_values
  • comparison of values and new_values yields no difference thus no request is sent.

The newticket page afaics currently works only by chance:

  • Because the input control #field-summary has class trac-autofocus it will be activated on load.
  • This means another control is losing focus
  • The blur event is sent causing the function trigger() to be called and the variable values gets initialized before any change made by the user.

You may test this by removing the class trac-autofocus in ticket.html. Afterwards any first change to any select control will have no effect.

There is a workaround (see below) for plugin developers. Sorry, I don't have a solution right now for the problem.

Workaround

To solve the issue in the plugin I just send the blur event to the element with the attached autoSubmit() handler so values is properly initialized prior to any user input.

jQuery(document).ready(function(){
    $("#field-type").autoSubmit({mw_refresh: '1', preview: '1'}, function(data, reply) {

        [...]

    }, "#action .trac-loading");
    $("#field-type").blur()
});

1 2 3 4 5 6 7 8 9 10 11


See also: TracQuery, TracTickets, TracReports

Last modified 10 months ago Last modified on Oct 15, 2019, 6:35:53 AM
Note: See TracWiki for help on using the wiki.