Changes between Version 12 and Version 13 of TicketQuery

Timestamp:

Feb 7, 2015, 12:25:00 PM (9 years ago)

Author:

figaro

Comment:

Added TicketQuery description

TicketQuery

@@ -1 +1 @@
 = !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 ==
+== Usage
+
 [[MacroList(TicketQuery)]]
 
-
-
-== Example ==
+== Example
 
 ||= **Example** =||= **Result** =||= **Macro** =||
@@ -77 +78 @@
 |-----------------------------------------------------------
 
+== 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)]]
+
+Finally, 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)]]
 
 ----