Edgewall Software

This page documents the 0.13 release. Documentation for other releases can be found here.

This page was a draft. See default TicketQuery page now.

TicketQuery Wiki Macro

TicketQuery macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.

This macro accepts a comma-separated list of keyed parameters, in the form "key=value", and can be used as follows:

[[TicketQuery([key=value][,key=value][,key=value]...)]]

If the key is the name of a ticket 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 (\).

The date keys created and modified can also constrain the criteria. Again, see TracQuery#QueryLanguage.

In addition to filters, several other named parameters can be used to control how the results are presented. All of them are optional.

The date keys created and modified can also constrain the criteria. Again, see TracQuery#QueryLanguage.

In addition to filters, several other named parameters can be used to control how the results are presented. All of them are optional.

KeyDescription & DetailsDefault
col Pipe-separated list of columns and its order to show (requires format=table). col=id|summary
|owner|type|
status|priority
|milestone
desc Reverse (true) the natural display order of the tickets. desc=false
format1 Sets how to display the list of tickets:
* list — ticket id next to the summary, each ticket on a separate line.
* compact — comma-separated list of ticket ids.
* count — the count of matching tickets
* table — similar to the custom query view (but without the controls)
* progress — a view similar to the milestone progress bars.
format=list
group Sets the ticket field for grouping tickets. None
groupdesc Reverse (true) the natural display order of the groups. groupdesc=false
max Sets the limit number of tickets to display (max=0 means no maximum). max=0
order Sets the ticket field for ordering tickets. order=id
rows Pipe-separated list of ticket fields to be viewed as a row, e.g. rows=description|summary (requires format=table) None
verboseGet the description for the listed tickets (true). Use with format=table only. Deprecated (< 0.12) in favor of the rows key. verbose=false
Note 1
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.
Note
Also, for compatibility with Trac 0.10, using "&" as a field separator still works (except for order) but is deprecated.

Example

  • Number of Triage tickets: 23
    • got with [[TicketQuery(status=new&milestone=, count)]]
  • Number of new tickets: 1030
    • got with [[TicketQuery(status=new, count)]]
  • Number of reopened tickets: 11
    • got with [[TicketQuery(status=reopened, count)]]
  • Number of assigned tickets: 43
    • got with [[TicketQuery(status=assigned, count)]]
  • Number of invalid tickets: 1503
    • got with [[TicketQuery(status=closed&resolution=invalid, count)]]
  • Number of worksforme tickets: 1395
    • got with [[TicketQuery(status=closed&resolution=worksforme, count)]]
  • Number of duplicate tickets: 2149
    • got with [[TicketQuery(status=closed&resolution=duplicate, count)]]
  • Number of wontfix tickets: 957
    • got with [[TicketQuery(status=closed&resolution=wontfix, count)]]
  • Number of fixed tickets: 4275
    • got with [[TicketQuery(status=closed&resolution=fixed, count)]]
  • Total number of tickets in Trac is 11911
    • got with [[TicketQuery(status=new|assigned|reopened|closed, count)]]
  • The last 5 modified tickets in Trac are: #12967, #12966, #12965, #12964, #12963 and the very last one is detailed below:

    Results (1 of 17)

    1 2 3 4 5 6 7 8 9 10 11
    Ticket Resolution Owner Reporter
    #12967 Jun Omae
    Summary Reduce joins and subqueries in query module when many custom fields are used
    1 2 3 4 5 6 7 8 9 10 11

    • got with [[TicketQuery(max=1,modified=lastmonth..thismonth, ,desc=1,format=table,col=resolution|owner|reporter,rows=summary)]]

See also: TracQuery, TracTickets, TracReports, TracGuide

Last modified 6 years ago Last modified on Jul 17, 2012, 9:24:42 PM
Note: See TracWiki for help on using the wiki.