wiki:TicketQuery

Version 2 (modified by trac, 5 weeks 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: 7 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 9 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 0 [[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: 2 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 4 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 1 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 12 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 8 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 43 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 8 [[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: #74, #72, #70 [[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 Gabor Hudiczius cyla <ghudiczius@gmail.com>
Summary stop/start/close/open multiple torrents

Format: list

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

This is displayed as:

No results

[[TicketQuery(id=123)]]

This is displayed as:

No results

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

1 2 3 4 5 6 7 8 9 10
Ticket Resolution Summary Owner Reporter
#55 invalid rTWi readouts (MB Downloaded, etc) incorrect/wrong Gabor Hudiczius Coburn64
#54 invalid Nowhere to Connect Gabor Hudiczius Erik
#53 invalid Using unix sockets generates message "Nowhere to connect (malformed address)" Gabor Hudiczius Will Marler
1 2 3 4 5 6 7 8 9 10

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

1 2 3 4 5 6 7 8 9 10
Ticket Resolution Summary Owner Reporter
#55 invalid rTWi readouts (MB Downloaded, etc) incorrect/wrong Gabor Hudiczius Coburn64
Description

Importing torrents into rTwi and then watching them glitches if I choose a different folder to save my torrent data in other than the default folder.

Example:

I load a 2.8GB Anime Torrent into rTwi, and it will accept the torrent and start it. However, the readout of the amount of data that it's downloaded (eg. 0.0/2.8GB) will instead say something like 0.0/-17283124 and the readout look really odd instead of (0.0/2.8GB ?).

The percentage will also say -40% and other things.

I haven't got a screenshot as my torrent box is down for repairs, but this is an annoying fault as it breaks the clean layout.

I'll attach a picture as to what I mean soon.

Cheers!

#54 invalid Nowhere to Connect Gabor Hudiczius Erik
Description

I'm trying to connect using the RPC socket, but it won't let me.

My users.conf says

[ERD] address = "unix://~/torrent/.socket/rpc.socket" pass = "SHA1 of my password"

My rpc.socket is in /home/ERD/torrent/.socket/rpc.socket

The rpc.socket does exist, and is CHMOD'd to 777. So my web server should have access to this.

I can't quite seem to figure out what's wrong here.

This is also set up on Fedora 12, I don't know if that means anything different for my set up. Thanks.

#53 invalid Using unix sockets generates message "Nowhere to connect (malformed address)" Gabor Hudiczius Will Marler
Description

I followed the instructions and tried the following combinations of entries:

<.rtorrent.rc> scgi_local = /var/torrent/.socket/rpc.socket

<rtwi's "users.conf"> [torrent] address = unix://var/torrent/.socket/rpc.socket pass = [a correct hash; I can log in no problems]

Whenever I log in though, I get "Nowhere to connect (malformed address)".

I assume I am configuring something incorrectly, but for the life of me I can't figure out what. I've tried all sorts of variations with / in the "unix:" address above, I've run "chmod 777 -R /var/torrent" and I've verified that on startup rtorrent puts a file "rpc.socket" in the /var/torrent/.socket directory. I'm completely stumped!

1 2 3 4 5 6 7 8 9 10


See also: TracQuery, TracTickets, TracReports

Note: See TracWiki for help on using the wiki.