wiki:TicketQuery

Version 1 (modified by trac, 3 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: 2 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 53 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 1 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 11 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 15 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 3 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 21 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 17 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 1236 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 2 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 1357 [[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: #1354, #1353, #1352 [[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 Jari Häkkinen Jari Häkkinen
Summary Reformat plug-ins archive/download page to look like the rest of the trac environment.

Format: list

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

This is displayed as:

#4
Spike Lowess
#5
Center on assay
#6
QQPlot
#7
Merge on genesymbol
#8
COPA
#9
Error in ReplicateError
#10
ReplicateError
#11
Pinbaes normalization
#16
BasicReporter and BasicSpot
#18
AnnotationFiletr
#19
RMA plugin should check that cel files are assigned to correct cdf.
#20
extra values pass through
#92
Create Illumina SNP raw data type
#125
MeV ... files are now supported (by the BASEcore) in the BASE analysis tree
#192
MeV unable to launch appplication ... class not found exception
#245
net.sf.basedb.illumina: Detection P-value fails if there is no negative controls in bioassayset
#296
VirtualArray plug-in can't be installed
#347
Exception when trying to register more than one specimen tube for a case
#393
Change default value for protocol in "RNA quality control - create aliquots" wizard step 2
#634
Retraction wizard
#866
Implement the "Start page" extension

[[TicketQuery(id=123)]]

This is displayed as:

#123
Update BasePlug-ins' firstpage

Format: compact

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

This is displayed as:

#4, #5, #6, #7, #8, #9, #10, #11, #16, #18, #19, #20, #92, #125, #192, #245, #296, #347, #393, #634, #866

Format: count

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

This is displayed as:

21

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

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#1357 fixed Update link descriptions after indexing Nicklas Nordborg Nicklas Nordborg
#1356 fixed Return results for all genotypes when the query include af, vd or dp fields Nicklas Nordborg Nicklas Nordborg
#1355 fixed Implement dialog for listing variants for a single raw bioassay Nicklas Nordborg Nicklas Nordborg
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 1292)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#1357 fixed Update link descriptions after indexing Nicklas Nordborg Nicklas Nordborg
Description

It would be nice to have a description text in the VCF file links. Note that Reggie already add descriptions so this should only be implemented on the Relax server.

#1356 fixed Return results for all genotypes when the query include af, vd or dp fields Nicklas Nordborg Nicklas Nordborg
Description

The targeted genotypes index include both variants (0/1, 1/1) and 0/0 genotypes. In most cases a query will only return results for variants (see [6380]). The exception is if the query include the gt: term. It would be useful to extend the exception to other fields that are related to the data for the individual sample as opposed to data fields that are related to the gene or gene annotations. The fields are: allele frequency (af:), depth (dp:) and variant depth (vd:).

#1355 fixed Implement dialog for listing variants for a single raw bioassay Nicklas Nordborg Nicklas Nordborg
Description

When there is no query for variants, the columns for displaying variant search results are used for displaying a count of the the number of variants for the raw bioassay. It would be nice to be able to open a popup dialog that list those variants (at least for the "filtered" and "targeted" indexes, it is less useful for the "all" column where there typically are several thousand variants).

It would also be nice to be able to link this dialog to file columns.

1 2 3 4 5 6 7 8 9 10 11


See also: TracQuery, TracTickets, TracReports