wiki:TicketQuery

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: 10 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 10 [[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: 0 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 2 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 3 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 8 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 64 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 10 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 88 [[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: #88, #52, #87 [[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 warmerdam mrcildp
Summary man listgeo

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#83 fixed Upgrade to EPSG v9.0 rouault rouault
#81 fixed Build issues with #include <geo_config.h> (vs #include "geo_config.h") warmerdam rouault
#80 fixed Patch to add subdir-objects option warmerdam Bas Couwenberg
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 77)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#83 fixed Upgrade to EPSG v9.0 rouault rouault
Description

GDAL corresponding ticket: https://trac.osgeo.org/gdal/ticket/6772 proj.4: https://github.com/OSGeo/proj.4/issues/477

#81 fixed Build issues with #include <geo_config.h> (vs #include "geo_config.h") warmerdam rouault
Description

Reported by Sebastiaan Couwenberg in http://lists.maptools.org/pipermail/geotiff/2016-September/000816.html

Between RC2 and 1.4.2 final geotiff.h was changed to include
<geo_config.h> instead of "geo_config.h".

This causes the librasterlite2 configure to fail because it cannot find
geo_config.h any more, because the Debian package installs the geotiff
headers in /usr/include/geotiff instead of /usr/include.

I think the change should be reverted at least for geotiff.h, I'm not
sure if the change in cpl_serv.h should be reverted too.

These changes were committed in r2736 to fix build issues on Windows,
will reverting to #include "geo_config.h" reintroduce the build failures
on Windows? If so, we should probably deal with this in Debian by
specifying the custom include path used by the libgeotiff package."""

Charles Karney confirms that reverting to #include "geotiff.h" is OK for now :

Yes, this change (reverting to #include "geo_config.h" in 1.4.2) works
OK with Windows.  Here are the "" vs <> issues in this case:

Pro <>: If users mix in-source builds on one platform with out-of-source
builds on another platform, then "" will pick up the version of
geo_config.h for the wrong platform.  I notice that out-of-source
autoconf builds don't work for libgeotiff, potentially exacerabating
this problem.  (This should probably be fixed at some point.)  You might
argue that anyone doing such inter-leaved builds is asking for trouble.
(And, of course, removing geo_config.h from the source distribution
helped.)

Pro "": If a user of libgeotiff uses #include <libgeotiff/geotiff.h>,
then <> won't find geo_config.h in the same directory (unless the
preprocessor is also told -I/usr/include/libgeotiff).

The second point is potentially troublesome (as noted by Bas) since some
distributions install the include files in /usr/include/libgeotiff and
there's no definitive guidance as to whether to use

   -I/usr/include + #include <libgeotiff/geotiff.h>

or

   -I/usr/include/libgeotiff + #include <geotiff.h>

The current install policies for libgeotiff (cmake + autoconf) suggest
that the latter form is expected.  I would say that the former is a
better practice; unfortunately transitioning the installed base to this
convention would be difficult.  Compounding the problem, Debian and
Fedora choose different include directories (geotiff vs libgeotiff).

Short term, I recommend:

(1) revert to

   #include "geo_config.h"

(2) make out-of-source autoconf builds work

(3) document that in-source builds (either with cmake or autoconf) are
not supported (possibly even disable them).
#80 fixed Patch to add subdir-objects option warmerdam Bas Couwenberg
Description

Automake warns about the lack of the subdir-objects option:

Makefile.am:104: warning: source file 'csv/datum.c' is in a subdirectory,
Makefile.am:104: but option 'subdir-objects' is disabled
automake: warning: possible forward-incompatibility.
automake: At least a source file is in a subdirectory, but the 'subdir-objects'
automake: automake option hasn't been enabled.  For now, the corresponding output
automake: object file(s) will be placed in the top-level directory.  However,
automake: this behaviour will change in future Automake versions: they will
automake: unconditionally cause object files to be placed in the same subdirectory
automake: of the corresponding sources.
automake: You are advised to start using 'subdir-objects' option throughout your
automake: project, to avoid future incompatibilities.
Makefile.am:104: warning: source file 'csv/ellipsoid.c' is in a subdirectory,
Makefile.am:104: but option 'subdir-objects' is disabled
Makefile.am:104: warning: source file 'csv/gcs.c' is in a subdirectory,
Makefile.am:104: but option 'subdir-objects' is disabled
Makefile.am:104: warning: source file 'csv/pcs.c' is in a subdirectory,
Makefile.am:104: but option 'subdir-objects' is disabled
Makefile.am:104: warning: source file 'csv/prime_meridian.c' is in a subdirectory,
Makefile.am:104: but option 'subdir-objects' is disabled
Makefile.am:104: warning: source file 'csv/projop_wparm.c' is in a subdirectory,
Makefile.am:104: but option 'subdir-objects' is disabled
Makefile.am:104: warning: source file 'csv/unit_of_measure.c' is in a subdirectory,
Makefile.am:104: but option 'subdir-objects' is disabled

Adding the option to AUTOMAKE_OPTIONS resolves the issue.

1 2 3 4 5 6 7 8 9 10 11


See also: TracQuery, TracTickets, TracReports

Last modified 2 years ago Last modified on May 8, 2022, 3:11:16 PM
Note: See TracWiki for help on using the wiki.