wiki:TicketQuery

Version 1 (modified by trac, 3 months ago) (diff)

--

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: 53 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 1 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 2 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 10 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 5 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 9 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 32 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 389 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 0 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 501 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 6 [[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: #530, #533, #532 [[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 Jari Häkkinen Jari Häkkinen
Summary Newly added (but not commitet) file makes svnstat crash

Format: list

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

This is displayed as:

#386
Make revision number in file listing clickable, the action should be to take the user that revision in the repo.

[[TicketQuery(id=123)]]

This is displayed as:

#123
Change commits by wwwrun to owner jari with SQL magic

Format: compact

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

This is displayed as:

#386

Format: count

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

This is displayed as:

1

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:

Results (1 - 3 of 445)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#533 fixed `make check` (repo_test.sh) fails with plplot 5.11 Jari Häkkinen Jari Häkkinen
#532 fixed svndigest build system is broken with plplot release 5.11 Jari Häkkinen Jari Häkkinen
#530 fixed missing help2man has changed semantics Jari Häkkinen Peter Johansson
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 445)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#533 fixed `make check` (repo_test.sh) fails with plplot 5.11 Jari Häkkinen Jari Häkkinen
Description

The reason for this is that plplot issues a warning to stderr

*** PLPLOT WARNING ***
All pages after the first skipped because family file output not specified.

The statement is correct since we do not want family file output. Explicitly turning of familying does not remove the warning message. A consequence of turning on familying is that all generated graphics files will have changed names.

#532 fixed svndigest build system is broken with plplot release 5.11 Jari Häkkinen Jari Häkkinen
Description

The good news is that plplot development is active again and the slightly bad news is that the 5.11 release has made changes to library file names. This means that svndigest build system needs a refresh.

plplot 5.11 announcement https://sourceforge.net/p/plplot/news/2015/04/plplot-5110-has-been-released/

Macports is changing to plplot 5.11.0 (https://trac.macports.org/ticket/47958) soon.

#530 fixed missing help2man has changed semantics Jari Häkkinen Peter Johansson
Description

missing has changed behaviour in this commit

http://git.savannah.gnu.org/cgit/automake.git/commit/lib/missing?id=a22717dffe37f30ef2ad2c355b68c9b3b5e4b8c7

which means that at least automake 1.13 has this behaviour. In short it means that make will fail if help2man is not available, which is not what we want. We want to be able to build svndigest with no help2man but that in that case 'make dist' or at least 'make distcheck' should fail.

1 2 3 4 5 6 7 8 9 10 11


See also: TracQuery, TracTickets, TracReports