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: 172 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 512 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 1 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 25 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 10 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 20 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 24 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 18 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 348 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 175 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 958 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 14 [[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: #963, #964, #962 [[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 nobody oranfry
Summary Update Developers Guide

Format: list

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

This is displayed as:

#8
Local library lock file problems
#23
exportcol.pl output dir check
#37
GenericList add 'removeprefix' option
#41
Upgrade to a newer version of wv
#52
Library cgiarg options
#133
Basing a collection on an existing one
#166
First characters in the log file
#170
Public/private document authentication
#189
New value in the attribute tables
#210
XMLcustom plugin needed for extracting metadata from XML documents
#322
Dragging and dropping files with weird characters into GLI
#360
cd-rom exported collection search problem
#393
RemoteGreenstoneServer and GLIApplet tasks
#401
Approximate_size option for GenericList
#407
search result sorting-ccs
#439
Integrate the GLI code that Amin sent for working with RL languages into current GLI
#447
Test Berry Baskets
#503
lucene collections on exported cd-rom
#518
Add option to installer to enable admin facility
#527
opening non-gli collections
#535
GLI load non-GLI collections
#540
collectgroups in Greenstone 3
#553
collectgroup gs3 in GLI
#619
apache on windows

[[TicketQuery(id=123)]]

This is displayed as:

#123
Windows 2000 EOF problem

Format: compact

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

This is displayed as:

#8, #23, #37, #41, #52, #133, #166, #170, #189, #210, #322, #360, #393, #401, #407, #439, #447, #503, #518, #527, #535, #540, #553, #619

Format: count

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

This is displayed as:

24

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#963 fixed Shorter URL path to usersDB nobody anupama
#962 fixed Admin should be able to remove user comments nobody anupama
#957 fixed Getting enriched meta to stick in GLI with special chars and encodings in subfolders and filenames ak19 ak19
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 420)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#963 fixed Shorter URL path to usersDB nobody anupama
Description

Task description: get the Networked Derby Driver to use the shorter URL to the usersDB of the form jdbc:derby://derbyserver:derbyport/usersDB, instead of the full path to usersDB after the protocol.

It needed setting derby.system.home JAVA_OPT when starting up the derby server in build.xml, then the tomcat greenstone3.xml file needed to refer to the shorter URL. Then classes that used to pass the full path need to pass the shorter form. And those classes called from the command line with full usersDB path, like ModifyUsersDB, needed to now pass the shorter path. So build.xml needed further updating when calling ModifyUsersDB. The full path still works (for example, you can connect to both the original jdbc:derby URL and the shorter URL now from Squirrel SQL Client now), but the code now uses the shorter path.

#962 fixed Admin should be able to remove user comments nobody anupama
Description

Ticket to summarise the task and bring together the revisions pertaining to this change (in case they need to be undone for testing).

When admin is logged in, there should be check boxes next to user comments on a document page and a Delete button, so the admin can delete it.

Implemented remove-metadata-array perl functions (in modmetadataaction.pm) and javascript wrapper for this (in javascript-global-functions.js), called from user_comments.js. Some additional changes in usercomments.xsl such as to check it's the admin user, and changes in runtime Java code GS2Construct.java to also ensure the remove-metadata-array perl commands can't be issued from a URL/terminal by non-admin users.

It took a little time as I needed to implement the remove-metadata-array perl subroutines correctly, and not break existing code when refactoring into utility internal methods. And the JavaScript ajax async/sync calls needed to handle with gsdl_cgi->generate_error() calls causing otherwise silent die statements (which don't show up as errors duing an ajax call, without checking for them manually in the ajax success-response).

Changesets:

https://trac.greenstone.org/changeset/38188 to https://trac.greenstone.org/changeset/38194

https://trac.greenstone.org/changeset/38217 to https://trac.greenstone.org/changeset/38219

https://trac.greenstone.org/changeset/38231 to https://trac.greenstone.org/changeset/38234

https://trac.greenstone.org/changeset/38237, https://trac.greenstone.org/changeset/38238

https://trac.greenstone.org/changeset/38248, https://trac.greenstone.org/changeset/38251

#957 fixed Getting enriched meta to stick in GLI with special chars and encodings in subfolders and filenames ak19 ak19
Description

Getting enriched meta to stick in GLI with special chars and encodings in subfolders and filenames. Affected were doc.xml and metadata.xml when Gathered subfolder names and filenames contained special characters (&, + and accented chars or unicode chars beyond ascii).

Now that I have added a new bugfix related to the issue and noticed there was no ticket that brought together all the commit revisions that comprised the overall fix for this topic, I am going to try to list all the commits here.

http://trac.greenstone.org/changeset/33724,

http://trac.greenstone.org/changeset/33726 to http://trac.greenstone.org/changeset/33730

http://trac.greenstone.org/changeset/33737 to http://trac.greenstone.org/changeset/33739

http://trac.greenstone.org/changeset/33744 to http://trac.greenstone.org/changeset/33751

http://trac.greenstone.org/changeset/33756 to http://trac.greenstone.org/changeset/33758

http://trac.greenstone.org/changeset/33777

And today's bugfix: http://trac.greenstone.org/changeset/34105

1 2 3 4 5 6 7 8 9 10 11


See also: TracQuery, TracTickets, TracReports

Note: See TracWiki for help on using the wiki.