close
Warning:
Can't synchronize with repository "(default)" (The repository directory has changed, you should resynchronize the repository with: trac-admin $ENV repository resync '(default)'). Look in the Trac log for more information.
- Timestamp:
-
2020-07-23T14:06:24-07:00 (4 years ago)
- Author:
-
trac
- Comment:
-
--
Legend:
- Unmodified
- Added
- Removed
- Modified
-
v1
|
v2
|
|
1 | 1 | = !TicketQuery Wiki Macro |
2 | 2 | |
3 | | The !TicketQuery macro lets you display information on tickets within wiki pages. |
4 | | The query language used by the `[[TicketQuery]]` macro is described in [TracQuery#QueryLanguage TracQuery] page. |
| 3 | The !TicketQuery macro lets you display ticket information anywhere that accepts WikiFormatting. |
| 4 | The query language used by the `[[TicketQuery]]` macro is described in the [TracQuery#QueryLanguage TracQuery] page. |
5 | 5 | |
6 | 6 | == Usage |
… |
… |
|
8 | 8 | [[MacroList(TicketQuery)]] |
9 | 9 | |
10 | | == Example |
| 10 | == Examples |
11 | 11 | |
12 | 12 | ||= **Example** =||= **Result** =||= **Macro** =|| |
… |
… |
|
47 | 47 | || **[[TicketQuery(status=closed,resolution=fixed,count)]]**||\ |
48 | 48 | || `[[TicketQuery(status=closed,resolution=fixed,count)]]` || |
| 49 | |----------------------------------------------------------- |
| 50 | ||=Number of untriaged tickets (milestone unset): =||\ |
| 51 | || **[[TicketQuery(status!=closed,milestone=,count)]]**||\ |
| 52 | || `[[TicketQuery(status!=closed,milestone=,count)]]` || |
49 | 53 | |----------------------------------------------------------- |
50 | 54 | ||=Total number of tickets: =||\ |
… |
… |
|
102 | 106 | |----------------------------------------------------------- |
103 | 107 | |
104 | | == Using the `[[TicketQuery]]` Macro |
| 108 | === Format: list |
105 | 109 | |
106 | | The [trac:TicketQuery TicketQuery] macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting. |
107 | | |
108 | | Example: |
109 | 110 | {{{ |
110 | 111 | [[TicketQuery(version=0.6|0.7&resolution=duplicate)]] |
… |
… |
|
114 | 115 | [[TicketQuery(version=0.6|0.7&resolution=duplicate)]] |
115 | 116 | |
116 | | 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: |
117 | 117 | {{{ |
118 | 118 | [[TicketQuery(id=123)]] |
… |
… |
|
122 | 122 | [[TicketQuery(id=123)]] |
123 | 123 | |
124 | | A more compact representation without the ticket summaries is: |
| 124 | === Format: compact |
| 125 | |
125 | 126 | {{{ |
126 | 127 | [[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]] |
… |
… |
|
130 | 131 | [[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]] |
131 | 132 | |
132 | | If you wish to receive only the number of defects that match the query, use the `count` parameter: |
| 133 | === Format: count |
| 134 | |
133 | 135 | {{{ |
134 | 136 | [[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]] |
… |
… |
|
138 | 140 | [[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]] |
139 | 141 | |
140 | | A graphical use of the macro is with the `format=progress` attribute: |
| 142 | === Format: progress |
| 143 | |
141 | 144 | {{{ |
142 | 145 | [[TicketQuery(milestone=0.12.8&group=type,format=progress)]] |
143 | 146 | }}} |
144 | 147 | |
145 | | For example for one of the upcoming milestones, bars are shown by ticket type: |
146 | | [[TicketQuery(milestone=0.12.8&group=type,format=progress)]] |
| 148 | This is displayed as: |
| 149 | [[TicketQuery(milestone=0.12.8&group=type,format=progress)]] |
| 150 | |
| 151 | === Format: table |
| 152 | |
| 153 | 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: |
| 154 | {{{ |
| 155 | [[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]] |
| 156 | }}} |
| 157 | |
| 158 | This is displayed as: |
| 159 | [[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]] |
| 160 | |
| 161 | ==== Full rows |
| 162 | |
| 163 | In ''table'' format you can specify full rows using `rows=<field>`: |
| 164 | {{{ |
| 165 | [[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]] |
| 166 | }}} |
| 167 | |
| 168 | This is displayed as: |
| 169 | [[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]] |
147 | 170 | |
148 | 171 | ---- |
149 | | See also: TracQuery, TracTickets, TracReports, TracGuide |
| 172 | See also: TracQuery, TracTickets, TracReports |