Changes between Version 3 and Version 4 of TracQuery

Timestamp:

Jan 25, 2010, 5:04:34 PM (15 years ago)

Author:

trac

Comment:

--

TracQuery

@@ -16 +16 @@
 Clicking on one of the query results will take you to that ticket.  You can navigate through the results by clicking the ''Next Ticket'' or ''Previous Ticket'' links just below the main menu bar, or click the ''Back to Query'' link to return to the query page.  
 
-You can safely edit any of the tickets and continue to navigate through the results using the ''Next/Previous/Back to Query'' links after saving your results.  When you return to the query ''any tickets which was edited'' will be displayed with italicized text.  If one of the tickets was edited such that [[html(<span style="color: grey">it no longer matches the query criteria </span>)]] the text will also be greyed. Lastly, if '''a new ticket matching the query critera has been created''', it will be shown in bold. 
+You can safely edit any of the tickets and continue to navigate through the results using the ''Next/Previous/Back to Query'' links after saving your results.  When you return to the query ''any tickets which were edited'' will be displayed with italicized text.  If one of the tickets was edited such that [[html(<span style="color: grey">it no longer matches the query criteria </span>)]] the text will also be greyed. Lastly, if '''a new ticket matching the query criteria has been created''', it will be shown in bold. 
 
 The query results can be refreshed and cleared of these status indicators by clicking the ''Update'' button again.
@@ -46 +46 @@
 === Using the `[[TicketQuery]]` Macro ===
 
-The `[[TicketQuery]]` macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.
+The [trac:TicketQuery TicketQuery] macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.
 
 Example:
 {{{
-[[TicketQuery(version=1.0|2.0&resolution=duplicate)]]
+[[TicketQuery(version=0.6|0.7&resolution=duplicate)]]
 }}}
 
 This is displayed as:
-  [[TicketQuery(version=1.0|2.0&resolution=duplicate)]]
+  [[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].
@@ -60 +60 @@
 A more compact representation without the ticket summaries is also available:
 {{{
-[[TicketQuery(version=1.0|2.0&resolution=duplicate, compact)]]
+[[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
 }}}
 
 This is displayed as:
-  [[TicketQuery(version=1.0|2.0&resolution=duplicate, compact)]]
+  [[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
+
+Finally if you wish to receive only the number of defects that match the query using 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)]]
+
+=== Customizing the ''table'' format ===
+You can also customize the columns displayed in the table format (''format=table'') by using ''col=<field>'' - you can specify multiple fields and what order they are displayed by placing pipes (`|`) between the columns like below:
+
+{{{
+[[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 also have full rows by using ''rows=<field>'' like below:
+
+{{{
+[[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)]]
+
 
 === Query Language ===
 
-`query:` TracLinks and the `[[TicketQuery]]` macro both use a mini “query language” for specifying query filters. Basically, the filters are separate by ampersands (`&`). Each filter then consists of the ticket field name, an operator, and one or more values. More than one value are separated by a pipe (`|`), meaning that the filter matches any of the values.
+`query:` TracLinks and the `[[TicketQuery]]` macro both use a mini “query language” for specifying query filters. Basically, the filters are separated by ampersands (`&`). Each filter then consists of the ticket field name, an operator, and one or more values. More than one value are separated by a pipe (`|`), meaning that the filter matches any of the values.
 
 The available operators are:
-|| '''=''' || the field content exactly matches the one of the values ||
-|| '''~=''' || the field content contains one or more of the values ||
-|| '''!^=''' || the field content starts with one of the values ||
-|| '''$=''' || the field content ends with one of the values ||
+|| '''`=`''' || the field content exactly matches the one of the values ||
+|| '''`~=`''' || the field content contains one or more of the values ||
+|| '''`^=`''' || the field content starts with one of the values ||
+|| '''`$=`''' || the field content ends with one of the values ||
 
 All of these operators can also be negated:
-|| '''!=''' || the field content matches none of the values ||
-|| '''!~=''' || the field content does not contain any of the values ||
-|| '''!!^=''' || the field content does not start with any of the values ||
-|| '''!$=''' || the field content does not end with any of the values ||
+|| '''`!=`''' || the field content matches none of the values ||
+|| '''`!~=`''' || the field content does not contain any of the values ||
+|| '''`!^=`''' || the field content does not start with any of the values ||
+|| '''`!$=`''' || the field content does not end with any of the values ||
+
 
 ----