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:	6	[[TicketQuery(status=new,count)]]
Number of reopened tickets:	1	[[TicketQuery(status=reopened,count)]]
Number of assigned tickets:	0	[[TicketQuery(status=assigned,count)]]
Number of invalid tickets:	350	[[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets:	47	[[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets:	136	[[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets:	231	[[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets:	4157	[[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset):	0	[[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets:	4941	[[TicketQuery(count)]]
Number of tickets reported or owned by current user:	12	[[TicketQuery(reporter=$USER,or,owner=$USER,count)]]
Number of tickets created this month:	10	[[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:	#5628, #5627, #5626	[[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 highos@… bugzilla@… Summary Testing bugzilla

Format: list

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

This is displayed as:

No results

[[TicketQuery(id=123)]]

This is displayed as:

#123

Change patches to sed's where possible

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

1 2 3 4 5 6 7 8 9 10 11 →

Ticket	Resolution	Summary	Owner	Reporter
#5625	fixed	shadow-4.17.2	lfs-book	Bruce Dubbs
#5624	fixed	util-linux-2.40.4	lfs-book	Bruce Dubbs
#5623	fixed	sysklogd-2.7.0	lfs-book	Bruce Dubbs

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

1 2 3 4 5 6 7 8 9 10 11 →

Ticket	Resolution	Summary	Owner	Reporter
#5625	fixed	shadow-4.17.2	lfs-book	Bruce Dubbs
Description	New point version.
#5624	fixed	util-linux-2.40.4	lfs-book	Bruce Dubbs
Description	New point version. util-linux v2.40.3 Release Notes Changes between v2.40.2 and v2.40.3 agetty: Prevent cursor escape add "systemd" to --version output fix ambiguous ‘else’ [-Werror=dangling-else] audit-arch.h: add defines for m68k, sh autotools: Check for BPF_OBJ_NAME_LEN (required by lsfd) add --disable-enosys, check for linux/audit.h add Libs.private to uuid.pc allow enabling dmesg with --disable-all-programs allow enabling lsblk with --disable-all-programs check for sys/vfs.h and linux/bpf.h fix securedir and pam_lastlog2 install bash-completion: add --pty and --no-pty options for su and runuser complete --user only for runuser, not for su chcpu(8): Document CPU deconfiguring behavior Fix typo ci: bump coveralls compiler version to gcc 13 doc: fsck.8.adoc - fix email typo docs: update AUTHORS file fdisk: (man) improve --sector-size description fix SGI boot file prompt fix fdisk_sgi_set_bootfile return value fix sgi_check_bootfile name size minimum fix sgi_menu_cb return value fincore: Use correct syscall number for cachestat on alpha fstab.5 mount: fstab.5 mount.8 add note about field separator hardlink: fix memory corruption (size calculation) hardlink.1 directory|file is mandatory hwclock: Remove ioperm declare as it causes nested extern declare warning lib/env: fix env_list_setenv() for strings without '=' libblkid: (exfat) validate fields used by prober (gpt) use blkid_probe_verify_csum() for partition array checksum add FSLASTBLOCK for swaparea bitlocker add image for Windows 7+ BitLocker bitlocker fix version on big-endian systems improve portability libfdisk: make sure libblkid uses the same sector size libmount: exec mount helpers with posixly correct argument order extract common error handling function propagate first error of multiple filesystem types libmount/context_mount: fix argument number comments logger: correctly format tv_usec lscpu: Skip aarch64 decode path for rest of the architectures make code more readable lslocks: remove deadcode [coverity scan] lsns: ignore ESRCH errors reported when accessing files under /proc man pages: document --user option for runuser use user rather than username meson: check for BPF_OBJ_NAME_LEN and linux/bpf.h mkswap: set selinux label also when creating file more: make sure we have data on stderr nsenter: support empty environ[] partx: Fix example in man page po: merge changes update de.po (from translationproject.org) update ja.po (from translationproject.org) update pt_BR.po (from translationproject.org) update sr.po (from translationproject.org) update zh_CN.po (from translationproject.org) po-man: add missing langs to po4a.cfg fix typo, update .gitignore merge changes update fr.po (from translationproject.org) update pt_BR.po (from translationproject.org) tests: fdisk/bsd Update expected output for alpha umount, losetup: Document loop destroy behavior uuidd: fix /var/lib/libuuid mode uuidd-tmpfiles.conf fix typo in tmpfiles.conf
#5623	fixed	sysklogd-2.7.0	lfs-book	Bruce Dubbs
Description	New minor version.

1 2 3 4 5 6 7 8 9 10 11 →

---

See also: TracQuery, TracTickets, TracReports