wiki:TicketQuery

Version 1 (modified by trac, 4 years 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: 19 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 28 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 1 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 5 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 2 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 0 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 0 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 24 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 21 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 63 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 1 [[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: #51, #53, #63 [[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 RBRi RBRi
Summary "Tools"\"Save to LNG file..." some items not updated

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

1 2 3 4 5 6 7 8 9
Ticket Resolution Summary Owner Reporter
#54 fixed (Building) Cannot add required components to Sibyl IDE ataylor
#51 invalid Trap on search for some terms in some inf files Gregg Young
#49 fixed When one instance of NewView is open on one virtual desktop, new instance should be opened on current one ataylor Lewis Rosenthal
1 2 3 4 5 6 7 8 9

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)

1 2 3 4 5 6 7 8 9
Ticket Resolution Summary Owner Reporter
#54 fixed (Building) Cannot add required components to Sibyl IDE ataylor
Description

Trying to set up a NewView build environment with Speedsoft Sibyl (fp3). The instructions in HOWTO.TXT work as far as building the SPU files; unfortunately, attempting to add the components to the Sibyl IDE always produces a cascading series of error popups, generally starting with a message the complib.dll .

Most classes seem to load successfully, except for CustomFontDialog? and TabSet2. Attempting to add either of these using Component -> Install results in an error popup "Could not load component library 'E:\Development\Sibyl\BIN\CompLib?.dll'!", and then a cascading series of error popups saying that NONE of the custom classes can be loaded, sometimes interspersed with some register exception popups.

I can verify that COMPLIB.DLL does exist in E:\Development\Sibyl\BIN:

 1-07-19  8:11p       687,616      0 a---  COMPLIB.DLL

NewView.SPR contains:

[Directories]

LastDir=P:\NEWVIEW_DEV\NEWVIEW
OutDir=P:\newview_dev\build\newview
LibDir=P:\newview_dev\build\components;P:\newview_dev\build\library;P:\newview_dev\build\sibyl\lib
LibSrcDir=P:\newview_dev\library;P:\newview_dev\sibyl\spcc;P:\newview_dev\components;P:\newview_dev\sibyl\rtl
IncSrcDir=
CompInstallDir=P:\NEWVIEW_DEV\build\components

[Directories OS/2]

LastDir=P:\newview_dev\NEWVIEW
OutDir=P:\newview_dev\build
LibDir=P:\newview_dev\build\sibyl\lib;P:\newview_dev\build\components;P:\newview_dev\build\library
LibSrcDir=P:\newview_dev\sibyl\spcc;P:\newview_dev\sibyl\rtl;P:\newview_dev\library;P:\newview_dev\components
IncSrcDir=
CompInstallDir=

Am I missing some critical configuration setting that isn't mentioned in the HOWTO.TXT?

#51 invalid Trap on search for some terms in some inf files Gregg Young
Description

Calling from eftepm Highlight "return" and open the open watcom 2.0 C reference guide. You get the following from newview. Note if you search "return" after opening this file (Watcom C guild) the same thing happens. It doesn't happen if you open the C++ guide

This application has crashed.

Access violation exception (EGPFault) occured at CS:EIP =$0000005B:$00012154 (Details logged to W:\VAR\LOG\NewView?.log)

Close application?

Newview log entry:

Running as process: W:\ECS\BIN\NEWVIEW.EXE 5 July 2015, 16:07:55 Exception type: EGPFault Description: Access violation exception (EGPFault) occured at CS:EIP =$0000005B:$00012154 Location: $000120AB Callstack:

$00012154

System version:20.45.0

OS/2 4.5

RAM: 2039 MB Boot drive: W Video resolution: 1024x768 Color depth: 32 bits Video driver: GRADD: VBE2GRAD Loaded files (2): U:\WATCOM\BINP\HELP\clib.inf U:\WATCOM\BINP\HELP\clr.inf Top-level open windows: 0

#49 fixed When one instance of NewView is open on one virtual desktop, new instance should be opened on current one ataylor Lewis Rosenthal
Description

NewView needs to be made XPager-aware. That is to say that when it has been launched on Desktop 1, and the user switches to Desktop 5, opens an application, and selects Help, NewView should open on the current desktop (5, in this case), and not cascaded with the first instance on Desktop 1.

I realize that this may actually be something for XPager to handle, and we can surely reference this ticket from the xTracker.

1 2 3 4 5 6 7 8 9


See also: TracQuery, TracTickets, TracReports