wiki:TicketQuery

Version 2 (modified by trac, on Aug 20, 2024 at 2:02:54 PM) ( 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: 0 [[TicketQuery(status=new&milestone=,count)]]
Number of new tickets: 0 [[TicketQuery(status=new,count)]]
Number of reopened tickets: 0 [[TicketQuery(status=reopened,count)]]
Number of assigned tickets: 0 [[TicketQuery(status=assigned,count)]]
Number of invalid tickets: 0 [[TicketQuery(status=closed,resolution=invalid,count)]]
Number of worksforme tickets: 0 [[TicketQuery(status=closed,resolution=worksforme,count)]]
Number of duplicate tickets: 5 [[TicketQuery(status=closed,resolution=duplicate,count)]]
Number of wontfix tickets: 4 [[TicketQuery(status=closed,resolution=wontfix,count)]]
Number of fixed tickets: 749 [[TicketQuery(status=closed,resolution=fixed,count)]]
Number of untriaged tickets (milestone unset): 0 [[TicketQuery(status!=closed,milestone=,count)]]
Total number of tickets: 758 [[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: 3 [[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: #758, #757, #756 [[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 update it, Inc. yasunaka
Summary NTLMおよびv2のプロキシー認証に未対応

Format: list

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

This is displayed as:

No results

[[TicketQuery(id=123)]]

This is displayed as:

#123
Wordインポートで表の罫線に対応する

Format: compact

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

This is displayed as:

No results

Format: count

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

This is displayed as:

0

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 in 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 758)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#758 fixed ver 2.1.11 メンテナンス・リリース#1 yasunaka
#757 fixed 目次で上付き文字・下付き文字が再現されない yasunaka
#756 fixed Wordインポートで見出し以降が取り込めなくなるケース yasunaka
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 758)

1 2 3 4 5 6 7 8 9 10 11
Ticket Resolution Summary Owner Reporter
#758 fixed ver 2.1.11 メンテナンス・リリース#1 yasunaka
Description

crossnoteクライアントのバージョンアップを行います。

  • リリース予定時期:2025年1月初
  • リリース対象モジュール: crossnoteクライアント

不具合対応

#756 Wordインポートで見出し以降が取り込めなくなるケース
#757 目次で上付き文字・下付き文字が再現されない

機能改善

#757 fixed 目次で上付き文字・下付き文字が再現されない yasunaka
Description

見出しや表・図形のタイトルなどに上付き文字・下付き文字が使われている場合に、目次においてそれが再現されない。

#756 fixed Wordインポートで見出し以降が取り込めなくなるケース yasunaka
Description

ファイルメニューの「新規作成時」→「ファイル...」からテンプレートを選んでファイルを作る場合には、用紙設定としてA4横とかA4縦などを選べるようになっており、かつこの設定についてUI上、直前の設定を覚えるようになっている。

一方、Wordファイルをcrossnote形式に変換して取り込む場合には上記のUIの選択が出来ないようにしており、Wordファイルの情報を元に縦横を判定してページ設定を行うようにしている。

ところが、WordファイルからのインポートにおいてもUIの情報を一旦参照して(つまり前に選択していた用紙設定を一旦取り出し)、それを元にcrossnoteファイルのデフォルトのページ設定を行い、次に読み込んだWordファイルのページ設定がそれと異なる場合には、ページ設定をし直した上でその中に変換したデータを取り込むようにしていた。

そしてこのように作られたcrossnoteドキュメントのデフォルトのページ設定とWordファイルのページ設定が異なるケースにおいて、最初に現れる見出し以降のデータが取込まれない状態になる場合がある。

問題点

  • 先頭に用紙設定を差し込んだ状態で見出し以降のデータが正しく取り込めない
  • Wordファイルのインポート変換において、ファイルの新規作成時に選択した用紙設定が動作に影響を与える

修正内容

  • ファイルメニューの「新規作成時」の用紙設定が出力結果に影響しないようにする
  • テンプレートの用紙設定と異なる用紙設定によるWordファイルをインポート変換した際、内容が正しく取り込まれるようにする
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.