Changes between Version 2 and Version 3 of TicketQuery

Timestamp:

2018-10-05T12:10:06+10:00 (6 years ago)

Author:

trac

Comment:

--

TicketQuery

@@ -1 +1 @@
 = !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#QueryLanguage TracQuery] page.
+The !TicketQuery macro lets you display information on tickets within wiki pages.
+The query language used by the `[[TicketQuery]]` macro is described in [TracQuery#QueryLanguage TracQuery] page.
 
 == Usage
@@ -8 +8 @@
 [[MacroList(TicketQuery)]]
 
-== Examples
+== Example
 
 ||= **Example** =||= **Result** =||= **Macro** =||
@@ -47 +47 @@
 || **[[TicketQuery(status=closed,resolution=fixed,count)]]**||\
 || `[[TicketQuery(status=closed,resolution=fixed,count)]]` ||
-|-----------------------------------------------------------
-||=Number of untriaged tickets (milestone unset): =||\
-|| **[[TicketQuery(status!=closed,milestone=,count)]]**||\
-|| `[[TicketQuery(status!=closed,milestone=,count)]]` ||
 |-----------------------------------------------------------
 ||=Total number of tickets: =||\
@@ -106 +102 @@
 |-----------------------------------------------------------
 
-=== Format: list
+== 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)]]
@@ -115 +114 @@
   [[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)]]
@@ -122 +122 @@
   [[TicketQuery(id=123)]]
 
-=== Format: compact
-
+A more compact representation without the ticket summaries is:
 {{{
 [[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
@@ -131 +130 @@
   [[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
 
-=== Format: count
-
+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)]]
@@ -140 +138 @@
   [[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]
 
-=== Format: progress
-
+A graphical use of the macro is with the `format=progress` attribute:
 {{{
 [[TicketQuery(milestone=0.12.8&group=type,format=progress)]]
 }}}
 
-This is displayed as:
-  [[TicketQuery(milestone=0.12.8&group=type,format=progress)]]
-
-=== 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:
-[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]
-
-==== 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:
-[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]]
+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
+See also: TracQuery, TracTickets, TracReports, TracGuide