wiki:TicketQuery

Version 2 (modified by trac, 2 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: 46 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 1 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 10 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 6 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 14 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 21 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 11 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 475 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 0 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 584 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 0 [[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: #16, #17, #30 [[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 Gregg Young
Summary Use Innotek FT2LIB in FM2

Format: list

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

This is displayed as:

No results

[[TicketQuery(id=123)]]

This is displayed as:

#123
Make RBuild page wiki-pretty

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 in 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 527)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#584 fixed Failure in certain Drag and Drop to the tree container Gregg Young John Small
#583 fixed Drive tree corruption on startup or rescan Gregg Young Gregg Young
#582 wontfix UnicodeDecodeError: 'ascii' codec can't decode byte 0xc3 in position 28: ordinal not in range(128) rob333
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 527)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#584 fixed Failure in certain Drag and Drop to the tree container Gregg Young John Small
Description

When I try to drag a file from within a directory container to a directory icon in the tree container it fails... if the target directory is the first child of its parent directory. The failure is that the "Don't drop on me" icon is displayed (even before I release the mouse button).

Other drag and drop operations seem to work properly.

If I create a new directory, making it the first child of the parent of the desired target, then the drop to the desired target (now the second child) works properly.

I will try to figure this out on my own. However, since I am not very experienced in PM programming, I will not assign it to myself (in hopes that someone more knowledgeable will look at it).

#583 fixed Drive tree corruption on startup or rescan Gregg Young Gregg Young
Description

50% of the time when I start fm2 the drive tree will contain misplaced or name corrupted directories. A Rescan or 2 will usually fix it. Occasionally it traps on rescan usually after I have gotten an error saying it can't find some directory (the name is a bunch of garbage characters -- not alphanumeric). Trp file attached. See the attached png to see an example of the tree corruption and to see my tree container settings

#582 wontfix UnicodeDecodeError: 'ascii' codec can't decode byte 0xc3 in position 28: ordinal not in range(128) rob333
Description

How to Reproduce

While doing a GET operation on /export/HEAD/tags/FM2-3_24_0/dirsize.c, Trac issued an internal error.

(please provide additional details here)

Request parameters:

{'format': 'raw', 'path': u'tags/FM2-3_24_0/dirsize.c', 'rev': u'HEAD'}

User agent: Mozilla/5.0 (OS/2; Warp 4.5; rv:45.0) Gecko/20100101 Firefox/45.0 SeaMonkey/2.42.9esr

System Information

System information not available

Enabled Plugins

Plugin information not available

Python Traceback

Traceback (most recent call last):
  File "/usr/local/lib/python2.7/site-packages/trac/web/main.py", line 554, in _dispatch_request
    dispatcher.dispatch(req)
  File "/usr/local/lib/python2.7/site-packages/trac/web/main.py", line 247, in dispatch
    resp = chosen_handler.process_request(req)
  File "/usr/local/lib/python2.7/site-packages/trac/versioncontrol/web_ui/browser.py", line 408, in process_request
    file_data = self._render_file(req, context, repos, node, rev)
  File "/usr/local/lib/python2.7/site-packages/trac/versioncontrol/web_ui/browser.py", line 669, in _render_file
    content = node.get_processed_content()
  File "/usr/local/lib/python2.7/site-packages/tracopt/versioncontrol/svn/svn_fs.py", line 802, in get_processed_content
    return FileContentStream(self, keyword_substitution, eol_style)
  File "/usr/local/lib/python2.7/site-packages/tracopt/versioncontrol/svn/svn_fs.py", line 1174, in __init__
    node._get_prop(core.SVN_PROP_KEYWORDS))
  File "/usr/local/lib/python2.7/site-packages/tracopt/versioncontrol/svn/svn_fs.py", line 1252, in _get_keyword_values
    for key, value in values.iteritems())
  File "/usr/local/lib/python2.7/site-packages/tracopt/versioncontrol/svn/svn_fs.py", line 1252, in <genexpr>
    for key, value in values.iteritems())
UnicodeDecodeError: 'ascii' codec can't decode byte 0xc3 in position 28: ordinal not in range(128)
1 2 3 4 5 6 7 8 9 10 11


See also: TracQuery, TracTickets, TracReports

Note: See TracWiki for help on using the wiki.