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: | 5 | [[TicketQuery(status=new&milestone=,count)]]
|
| Number of new tickets: | 5 | [[TicketQuery(status=new,count)]]
|
| Number of reopened tickets: | 0 | [[TicketQuery(status=reopened,count)]]
|
| Number of assigned tickets: | 0 | [[TicketQuery(status=assigned,count)]]
|
| Number of invalid tickets: | 2 | [[TicketQuery(status=closed,resolution=invalid,count)]]
|
| Number of worksforme tickets: | 2 | [[TicketQuery(status=closed,resolution=worksforme,count)]]
|
| Number of duplicate tickets: | 1 | [[TicketQuery(status=closed,resolution=duplicate,count)]]
|
| Number of wontfix tickets: | 0 | [[TicketQuery(status=closed,resolution=wontfix,count)]]
|
| Number of fixed tickets: | 22 | [[TicketQuery(status=closed,resolution=fixed,count)]]
|
| Number of untriaged tickets (milestone unset): | 5 | [[TicketQuery(status!=closed,milestone=,count)]]
|
| Total number of tickets: | 32 | [[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: | #32, #31, #30 | [[TicketQuery(max=3,order=modified,desc=1,compact)]]
|
Details of ticket #1: |
| |
| ||
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:
Format: progress
[[TicketQuery(milestone=0.12.8&group=type,format=progress)]]
This is displayed as:
defect
15 / 19
enhancement
12 / 13
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 27)
| Ticket | Resolution | Summary | Owner | Reporter |
|---|---|---|---|---|
| #28 | fixed | proxy62 na reboot no carrier op vr0 | ||
| #26 | fixed | var te klein / nsd te groot | ||
| #25 | fixed | proxyid in genesisconfig |
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 27)
| Ticket | Resolution | Summary | Owner | Reporter |
|---|---|---|---|---|
| #28 | fixed | proxy62 na reboot no carrier op vr0 | ||
| Description |
Als ik proxy62 een softreboot geef dan krijg ik een no carrier op vr0 vr0: flags=8843<UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST> metric 0 mtu 1500
Huub heeft al aangegeven dat het lampje gewoon knippert en groen is. |
|||
| #26 | fixed | var te klein / nsd te groot | ||
| Description |
De var partitie loopt vol op alle nieuwe proxies. De grootste boosdoener is nsd (ixfr file). Nagios werkt nierdoor ook niet goed (staan files op /tmp -> /var/tmp). manfile: difffile: <filename> When NSD receives IXFR updates it will store them in this file. This file contains the differences between the database file and the latest zone version. Default is /var/db/nsd/ixfr.db. Probleem lost zich vanzelf op als we overgaan op maradns, maar wel een aandachtspuntje voor maradns Proxy5# du -h /var | grep '[0-9]M' 2.1M /var/db/nsd 1.3M /var/db/pkg 3.5M /var/db 4.0M /var Proxy5# df -h Filesystem Size Used Avail Capacity Mounted on /dev/ad0s1a 393M 199M 163M 55% / devfs 1.0K 1.0K 0B 100% /dev /dev/md0 4.4M 1.5M 2.5M 37% /etc /dev/md1 4.4M 4.1M 6.0K 100% /var Proxy2# df -h Filesystem Size Used Avail Capacity Mounted on /dev/ad0s1a 393M 199M 163M 55% / devfs 1.0K 1.0K 0B 100% /dev /dev/md0 4.4M 1.5M 2.5M 37% /etc /dev/md1 4.4M 4.0M 30K 99% /var Proxy2# du -h /var | grep '[0-9]M' 2.1M /var/db/nsd 1.4M /var/db/pkg 3.5M /var/db 4.0M /var Proxy4# du -h /var/ | grep '[0-9]M' 2.1M /var/db/nsd 1.3M /var/db/pkg 3.5M /var/db 4.0M /var/ Proxy4# df -h Filesystem Size Used Avail Capacity Mounted on /dev/ad0s1a 393M 199M 163M 55% / devfs 1.0K 1.0K 0B 100% /dev /dev/md0 4.4M 1.5M 2.5M 37% /etc /dev/md1 4.4M 4.0M 56K 99% /var |
|||
| #25 | fixed | proxyid in genesisconfig | ||
| Description |
De proxyid in de genesis wleiden.conf file werkt alleen bij een getal van 2 cijfers. Niet echt een probleem als je het weet (0 er voor zetten). |
|||
See also: TracQuery, TracTickets, TracReports
