Edgewall Software

This page documents the 1.2 release. Documentation for other releases can be found here.

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: 22 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 1050 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 3 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 14 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 1515 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 1413 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 2183 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 990 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 4496 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 24 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 12249 [[TicketQuery(count)]]
Number of tickets reported or owned by current user: 1840 [[TicketQuery(reporter=$USER,or,owner=$USER,count)]]
Number of tickets created this month: 0 [[TicketQuery(created=thismonth..,count)]]
Number of closed Firefox tickets: 13 [[TicketQuery(status=closed,keywords~=firefox,count)]]
Number of closed Opera tickets: 12 [[TicketQuery(status=closed,keywords~=opera,count)]]
Number of closed tickets affecting Firefox and Opera: 1 [[TicketQuery(status=closed,keywords~=firefox opera,count)]]
Number of closed tickets affecting Firefox or Opera: 24 [[TicketQuery(status=closed,keywords~=firefox|opera,count)]]
Number of tickets that affect Firefox or are closed and affect Opera: 25 [[TicketQuery(status=closed,keywords~=opera,or,keywords~=firefox,count)]]
Number of closed Firefox tickets that don't affect Opera: 1 [[TicketQuery(status=closed,keywords~=firefox -opera,count)]]
Last 3 modified tickets: #6107, #9547, #3556 [[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 anonymous
Summary Add a new project summary module.

Format: list

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

This is displayed as:

#181
Wiki preview injects new lines
#204
request for colour legend (or something similar) for ticket groups in reports
#226
Ticket Dependencies
#239
Link to diff of specifik wiki change instead of the page itself
#351
All ticket modifications should be tracked in timeline
#413
Installing on Windows, drive other than C:
#450
Diffviewer should try to convert the text into utf-8.
#475
merging of similar tickets
#519
Python process sometimes hangs on Windows Server 2003
#529
IE 5-6 over HTTPS broken downloads

[[TicketQuery(id=123)]]

This is displayed as:

#123
No SQL error display

Format: compact

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

This is displayed as:

#181, #204, #226, #239, #351, #413, #450, #475, #519, #529

Format: count

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

This is displayed as:

10

Format: progress

[[TicketQuery(milestone=0.12.8&group=type,format=progress)]]

This is displayed as:

defect

5 / 5

enhancement

2 / 2

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:

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#13445 cantfix SyntaxError: invalid syntax ( class HTTPException(TracBaseError, metaclass = ABCMeta): Tomasz Brzezina <tomasz@…>
Description

I try to install 1.5.3 (I give up with 1.4 on bullseye).

Installed all needed packages and version 1.5.3:

pip install https://download.edgewall.org/trac/Trac-1.5.3-py3-none-any.whl

all needed packages installed with venv at /var/lib/trac/env

Apache2 uses wsgi:

WSGIScriptAlias /trac /var/lib/trac/apache/trac.wsgi
WSGIDaemonProcess trac python-path=/var/lib/trac:/var/lib/trac/env/lib/python3.9/site-packages

After apache2 restart accessing trac gives error:

Traceback (most recent call last):
File "/var/lib/trac/apache/trac.wsgi", line 13, in <module>
import trac.web.main
File "/var/lib/trac/env/lib/python3.9/site-packages/trac/web/__init__.py", line 14, in <module>
from trac.web.api import *
File "/var/lib/trac/env/lib/python3.9/site-packages/trac/web/api.py", line 195
class HTTPException(TracBaseError, metaclass=ABCMeta):
                                            ^
SyntaxError: invalid syntax

I can't see what's wrong.

#13443 cantfix Installation 1.4.3 at Debian 10 Tomasz Brzezina <tomasz@…>
Description

After some debian update I lost access to Trac (Python2.7⇒Python3 migration I suppose). So created virtual environment:

virtualenv -p /usr/bin/python2.7 env

And finally installation is succesful! (Hope this help somebody)

But… Stil can't run it by wsgi apache2:

Traceback (most recent call last):
  File "/var/lib/trac/apache/trac.wsgi", line 13, in <module>
    import trac.web.main
  File "/var/lib/trac/env/lib/python2.7/site-packages/trac/web/__init__.py", line 19, in <module>
    from trac.web.api import *
  File "/var/lib/trac/env/lib/python2.7/site-packages/trac/web/api.py", line 18, in <module>
    from BaseHTTPServer import BaseHTTPRequestHandler

I tried to install pip install http but still the same problem

my wsgi file:

import sys
sys.stdout = sys.stderr

import os

os.environ['PKG_RESOURCES_CACHE_ZIP_MANIFESTS'] = '1'
os.environ['TRAC_ENV_PARENT_DIR'] = '/var/lib/trac'
os.environ['PYTHON_EGG_CACHE'] = '/var/lib/trac/eggs'

#import trac.db.postgres_backend
#trac.db.postgres_backend.PostgreSQLConnection.poolable = False

import trac.web.main

application = trac.web.main.dispatch_request

I understand, that it is installation problem, but previously installation guide leads to success, but now - stucked. I can't use 1.5.3, because I need some plugins which are not available in 1.5 yet…

#13441 cantfix There is often problem to turn off the plugin anonymous
Description

Eg. after restart screen with app by fgci I can't turn off plugin by plugin manager as admin, must do this by trac.ini only

Error: Unable to check for upgrade of tracusermanager.api.EnvironmentFixKnownUsers:
TypeError: environment_needs_upgrade() takes exactly 2 arguments (1 given)
  • many not updated plugins doing this type problems
1 2 3 4 5 6 7 8 9 10 11


See also: TracQuery, TracTickets, TracReports

Last modified 2 years ago Last modified on Oct 15, 2019, 6:32:29 AM
Note: See TracWiki for help on using the wiki.