wiki:AutoQueryPlugin

Version 19 (modified by rjollos, 2 years ago) (diff)

No maintainer.

Display links to queries in ticket summary

This plugin will be deprecated in 0.12 as its functionality has been incorporated in trac core -- see trac:#7562

Description

In vanilla trac, the Reporter, Owner, Priority, etc. in the ticket summary are displayed as text. The AutoQueryPlugin changes these to links to query strings. For instance, out of the box, clicking on the reporter name will result in a link like:

http://127.0.0.1:14828/testproject/query?reporter=k0s&order=priority

The end part of the query string (&order=priority) is configurable in the .ini file.

The intent of this plugin is to make finding like tickets easier and to take advantage of the fact that these text items aren't links to something interesting and could be.

This plugin overrides the ticket.html template to do this. Ideally, this wouldn't have to be done, but it was the easiest solution to the problem.

Configuration Options

The AutoQueryPlugin supports two options in the [Autoquery] section of the trac.ini file (also configurable with the IniAdminPlugin). The relevant section with the option defaults would look like this:

[autoquery]
query_args = &order=priority
excluded_fields = estimatedhours, hours, totalhours

These options are as follows:

  • query_args: additional argument string to append to the query url (in the event the patch from #3226 is included in trac core, this string will be taken from the default_anonymous_query option in [query])
  • excluded_fields: fields not to mark as links using the AutoQueryPlugin; the defaults are to prevent conflicts with the TimingAndEstimationPlugin, which alters these fields with javascript

Bugs/Feature Requests

Existing bugs and feature requests for AutoQueryPlugin are here.

If you have any issues, create a new ticket.

Download and Source

Download the zipped source, check out using Subversion, or browse the source with Trac.

Example

After installing, usage should be straight forward. The text fields in the ticket badge will become links to queries. This can be seen in the openplans trac instance. For instance:

http://trac.openplans.org/openplans/ticket/1097

Recent Changes

[7228] by k0s on 2009-12-07 17:23:49
fixes #5428
[3836] by k0s on 2008-06-13 22:17:03
add excluded_fields to not be marked up by AutoQuery; fixes #3178
[3816] by k0s on 2008-06-10 17:57:33
if urllib fails, just pass on the query as is. could have space issues that may also need fixing; fixes #3157

Author/Contributors

originally developed at The Open Planning Project

Author: k0s
Maintainer: none
Contributors:

Attachments (1)

Download all attachments as: .zip