Changes between Version 1 and Version 2 of TracQuery


Ignore:
Timestamp:
12/04/2008 10:19:05 PM (16 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracQuery

    v1 v2  
    1616Clicking 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. 
    1717
    18 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 you edited will be displayed with italicized text.  If one of the tickets was edited such that it no longer matches the query criteria the text will also be greyed.  The query results can be refreshed and cleared of these status indicators by clicking the ''Update'' button again.
     18You 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.
     19
     20The query results can be refreshed and cleared of these status indicators by clicking the ''Update'' button again.
    1921
    2022== Saving Queries ==
    … …  
    2628You may want to save some queries so that you can come back to them later.  You can do this by making a link to the query from any Wiki page.
    2729{{{
    28 [query:status=new|assigned|reopened&version=0.8 Active tickets against 0.8]
     30[query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0]
    2931}}}
    3032
    3133Which is displayed as:
    32   [query:status=new|assigned|reopened&version=0.8 Active tickets against 0.8]
     34  [query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0]
    3335
    3436This uses a very simple query language to specify the criteria (see [wiki:TracQuery#QueryLanguage Query Language]).
    … …  
    3941}}}
    4042
    41 Whis is displayed as:
     43Which is displayed as:
    4244  [query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner]
    43 
    44 The advantage of this approach is that you can also specify the grouping and ordering, which is not possible using the first syntax.
    4545
    4646=== Using the `[[TicketQuery]]` Macro ===
    4747
    48 The `[[TicketQuery]]` macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.
     48The [trac:TicketQuery TicketQuery] macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.
    4949
    5050Example:
    5151{{{
    52 [[TicketQuery(version=0.9b1|0.9b2&resolution=duplicate)]]
     52[[TicketQuery(version=0.6|0.7&resolution=duplicate)]]
    5353}}}
    5454
    5555This is displayed as:
    56   [[TicketQuery(version=0.9b1|0.9b2&resolution=duplicate)]]
     56  [[TicketQuery(version=0.6|0.7&resolution=duplicate)]]
    5757
    5858Just 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].
    … …  
    6060A more compact representation without the ticket summaries is also available:
    6161{{{
    62 [[TicketQuery(version=0.9b1|0.9b2&resolution=duplicate, compact)]]
     62[[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
    6363}}}
    6464
    6565This is displayed as:
    66   [[TicketQuery(version=0.9b1|0.9b2&resolution=duplicate, compact)]]
     66  [[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
     67
     68Finally if you wish to receive only the number of defects that match the query using the ``count`` parameter.
     69
     70{{{
     71[[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]
     72}}}
     73
     74This is displayed as:
     75  [[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]
     76
     77=== Customizing the ''table'' format ===
     78You 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:
     79
     80{{{
     81[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]
     82}}}
     83
     84This is displayed as:
     85[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter)]]
     86
    6787
    6888=== Query Language ===
    6989
    70 `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.
     90`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.
    7191
    7292The available operators are:
    73 || '''=''' || the field content exactly matches the one of the values ||
    74 || '''~=''' || the field content contains one or more of the values ||
    75 || '''!^=''' || the field content starts with one of the values ||
    76 || '''$=''' || the field content ends with one of the values ||
     93|| '''`=`''' || the field content exactly matches the one of the values ||
     94|| '''`~=`''' || the field content contains one or more of the values ||
     95|| '''`^=`''' || the field content starts with one of the values ||
     96|| '''`$=`''' || the field content ends with one of the values ||
    7797
    7898All of these operators can also be negated:
    79 || '''!=''' || the field content matches none of the values ||
    80 || '''!~=''' || the field content does not contain any of the values ||
    81 || '''!!^=''' || the field content does not start with any of the values ||
    82 || '''!$=''' || the field content does not end with any of the values ||
     99|| '''`!=`''' || the field content matches none of the values ||
     100|| '''`!~=`''' || the field content does not contain any of the values ||
     101|| '''`!^=`''' || the field content does not start with any of the values ||
     102|| '''`!$=`''' || the field content does not end with any of the values ||
     103
    83104
    84105----