summaryrefslogtreecommitdiff
path: root/raw-wiki-dump/TicketQuery
blob: 8b6f877607e033a4e9708c6e86f732a8ed9eaa62 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
= !TicketQuery Wiki Macro

The !TicketQuery macro lets you display information on tickets within wiki pages.
The query language used by the `[[TicketQuery]]` macro is described in [TracQuery#UsingtheTicketQueryMacro TracQuery] page.

== Usage

[[MacroList(TicketQuery)]]

== Example

||= **Example** =||= **Result** =||= **Macro** =||
|-----------------------------------------------------------
||=Number of [query:status=new&milestone= Triage tickets]: =||\
|| **[[TicketQuery(status=new&milestone=,count)]]**||\
|| `[[TicketQuery(status=new&milestone=,count)]]` ||
|-----------------------------------------------------------
||=Number of new tickets: =||\
|| **[[TicketQuery(status=new,count)]]**||\
|| `[[TicketQuery(status=new,count)]]` ||
|-----------------------------------------------------------
||=Number of reopened tickets: =||\
|| **[[TicketQuery(status=reopened,count)]]**||\
|| `[[TicketQuery(status=reopened,count)]]` ||
|-----------------------------------------------------------
||=Number of assigned tickets: =||\
|| **[[TicketQuery(status=assigned,count)]]**||\
|| `[[TicketQuery(status=assigned,count)]]` ||
|-----------------------------------------------------------
||=Number of invalid tickets: =||\
|| **[[TicketQuery(status=closed,resolution=invalid,count)]]**||\
|| `[[TicketQuery(status=closed,resolution=invalid,count)]]` ||
|-----------------------------------------------------------
||=Number of worksforme tickets: =||\
|| **[[TicketQuery(status=closed,resolution=worksforme,count)]]**||\
|| `[[TicketQuery(status=closed,resolution=worksforme,count)]]` ||
|-----------------------------------------------------------
||=Number of duplicate tickets: =||\
|| **[[TicketQuery(status=closed,resolution=duplicate,count)]]**||\
|| `[[TicketQuery(status=closed,resolution=duplicate,count)]]` ||
|-----------------------------------------------------------
||=Number of wontfix tickets: =||\
|| **[[TicketQuery(status=closed,resolution=wontfix,count)]]**||\
|| `[[TicketQuery(status=closed,resolution=wontfix,count)]]` ||
|-----------------------------------------------------------
||=Number of fixed tickets: =||\
|| **[[TicketQuery(status=closed,resolution=fixed,count)]]**||\
|| `[[TicketQuery(status=closed,resolution=fixed,count)]]` ||
|-----------------------------------------------------------
||=Total number of tickets: =||\
|| **[[TicketQuery(count)]]**||\
|| `[[TicketQuery(count)]]` ||
|-----------------------------------------------------------
||=Number of tickets reported **or** owned by current user: =||\
|| **[[TicketQuery(reporter=$USER,or,owner=$USER,count)]]**||\
|| `[[TicketQuery(reporter=$USER,or,owner=$USER,count)]]` ||
|-----------------------------------------------------------
||=Number of tickets created this month: =||\
|| **[[TicketQuery(created=thismonth..,count)]]**||\
|| `[[TicketQuery(created=thismonth..,count)]]` ||
|-----------------------------------------------------------
||=Last 3 modified tickets: =||\
||**[[TicketQuery(max=3,order=modified,desc=1,compact)]]**||\
|| `[[TicketQuery(max=3,order=modified,desc=1,compact)]]` ||
|-----------------------------------------------------------
{{{#!th rowspan=2, style="text-align: left;"
Details of ticket #1:
}}}
{{{#!td style="border-bottom: 0;"
}}}
{{{#!td
`[[TicketQuery(id=1,col=id|owner|reporter,rows=summary,table)]]`
}}}
|-
{{{#!td colspan=2, style="border-top: 0;"
[[TicketQuery(id=1,col=id|owner|reporter,rows=summary,table)]]
}}}
|-----------------------------------------------------------

== Using the `[[TicketQuery]]` Macro

The [trac:TicketQuery TicketQuery] macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.

Example:
{{{
[[TicketQuery(version=0.6|0.7&resolution=duplicate)]]
}}}

This is displayed as:
  [[TicketQuery(version=0.6|0.7&resolution=duplicate)]]

Just like the [wiki:TracQuery#UsingTracLinks query: wiki links], the parameter of this macro expects a query string formatted according to the rules of the simple [wiki:TracQuery#QueryLanguage ticket query language]. This also displays the link and description of a single ticket:
{{{
[[TicketQuery(id=123)]]
}}}

This is displayed as:
  [[TicketQuery(id=123)]]

A more compact representation without the ticket summaries is:
{{{
[[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
}}}

This is displayed as:
  [[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]

If you wish to receive only the number of defects that match the query, use the `count` parameter:
{{{
[[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]
}}}

This is displayed as:
  [[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]

A graphical use of the macro is with the `format=progress` attribute:
{{{
[[TicketQuery(milestone=0.12.8&group=type,format=progress)]]
}}}

For example for one of the upcoming milestones, bars are shown by ticket type:
[[TicketQuery(milestone=0.12.8&group=type,format=progress)]]

----
See also: TracQuery, TracTickets, TracReports, TracGuide