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: 14 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 83 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 3 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 7 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 39 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 13 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 24 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 114 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 805 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 19 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 1088 [[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: 2 [[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: #2350, #2349, #2347 [[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
No tickets found

Format: list

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

This is displayed as:

#433
Change Language, Country and Keyboard-Layout at first boot
#449
All files should be owned by root, and writable by all
#463
Nice boot screen with Language option
#522
livedvd: update pgrouting script
#654
Marble: Wikipedia links need disambiguation
#767
geomajas: slightly longer startup delay needed
#778
regression test
#790
52N SOS doesn't have a stop icon
#891
docs: the sponsor pages are different between the different translations
#954
Geomajas fails to startup
#986
proposal for english documentation improvements
#1069
saga_gui.desktop is empty
#1094
pgRouting fails to load correctly
#1097
translate navigation bar
#1145
Remove privative libraries from Kosmo Desktop package
#1344
AtlasStyler : expired key in geopublishing.org's deb repo
#1349
qgis: sphinx tutorial build fails
#1403
uDig: crash when you click on the 'web' tab
#1429
Tilemill boot error message
#2051
review jupyter file
#2111
QGis 2.18 Plugins Broken
#2134
R version 0.7 demo
#2173
o13 docs broken links
#2270
Iris packaging review for focal

[[TicketQuery(id=123)]]

This is displayed as:

No results

Format: compact

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

This is displayed as:

#433, #449, #463, #522, #654, #767, #778, #790, #891, #954, #986, #1069, #1094, #1097, #1145, #1344, #1349, #1403, #1429, #2051, #2111, #2134, #2173, #2270

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#2350 wontfix Email list headers TEST osgeolive@… darkblueb
#2345 fixed Transifex changes osgeolive@… cvvergara
#2338 fixed update IRC link to Libera osgeolive@… enockseth
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 995)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#2350 wontfix Email list headers TEST osgeolive@… darkblueb
Description

check and moderate

#2345 fixed Transifex changes osgeolive@… cvvergara
Description

Transifex has made many changes

  • transifex.yml file is required with more or less the following contents
git:
  filters:
    - filter_type: dir
      file_format: PO
      source_file_extension: po
      source_language: en
      source_file_dir: locale/en/LC_MESSAGES
      # path expression to translation files, must contain <lang> placeholder
      translation_files_expression: 'locale/<lang>/LC_MESSAGES'
  • the tx python client is deprecated and the new one is in go language.

This client is used to pull the translations. So the person doing the task of pulling the translations need to install the new tx client.

  • the tx/config needs to be updated for the new tx client
  • Wiki documentation of how to download translations and building the translated language to check for sphinx errors is needed
#2338 fixed update IRC link to Libera osgeolive@… enockseth
Description

Update IRC link on WikiStart to Libera

1 2 3 4 5 6 7 8 9 10 11


See also: TracQuery, TracTickets, TracReports

Last modified 11 days ago Last modified on 8 May 2022, 15:12:42
Note: See TracWiki for help on using the wiki.