Changes between Version 1 and Version 2 of TicketQuery


Ignore:
Timestamp:
2020-07-10T19:42:25Z (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TicketQuery

    v1 v2  
    11= !TicketQuery Wiki Macro
    22
    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#UsingtheTicketQueryMacro TracQuery] page.
     3The !TicketQuery macro lets you display ticket information anywhere that accepts WikiFormatting.
     4The query language used by the `[[TicketQuery]]` macro is described in the [TracQuery#QueryLanguage TracQuery] page.
    55
    66== Usage
    … …  
    88[[MacroList(TicketQuery)]]
    99
    10 == Example
     10== Examples
    1111
    1212||= **Example** =||= **Result** =||= **Macro** =||
    … …  
    4848|| `[[TicketQuery(status=closed,resolution=fixed,count)]]` ||
    4949|-----------------------------------------------------------
     50||=Number of untriaged tickets (milestone unset): =||\
     51|| **[[TicketQuery(status!=closed,milestone=,count)]]**||\
     52|| `[[TicketQuery(status!=closed,milestone=,count)]]` ||
     53|-----------------------------------------------------------
    5054||=Total number of tickets: =||\
    5155|| **[[TicketQuery(count)]]**||\
    … …  
    5963|| **[[TicketQuery(created=thismonth..,count)]]**||\
    6064|| `[[TicketQuery(created=thismonth..,count)]]` ||
     65|-----------------------------------------------------------
     66||=Number of closed Firefox tickets: =||\
     67|| **[[TicketQuery(status=closed,keywords~=firefox,count)]]**||\
     68|| `[[TicketQuery(status=closed,keywords~=firefox,count)]]` ||
     69|-----------------------------------------------------------
     70||=Number of closed Opera tickets: =||\
     71|| **[[TicketQuery(status=closed,keywords~=opera,count)]]**||\
     72|| `[[TicketQuery(status=closed,keywords~=opera,count)]]` ||
     73|-----------------------------------------------------------
     74||=Number of closed tickets affecting Firefox and Opera: =||\
     75|| **[[TicketQuery(status=closed,keywords~=firefox opera,count)]]**||\
     76|| `[[TicketQuery(status=closed,keywords~=firefox opera,count)]]` ||
     77|-----------------------------------------------------------
     78||=Number of closed tickets affecting Firefox or Opera: =||\
     79|| **[[TicketQuery(status=closed,keywords~=firefox|opera,count)]]**||\
     80|| `[[TicketQuery(status=closed,keywords~=firefox|opera,count)]]` ||
     81|-----------------------------------------------------------
     82||=Number of tickets that affect Firefox or are closed and affect Opera: =||\
     83|| **[[TicketQuery(keywords~=firefox,or,status=closed,keywords~=opera,count)]]**||\
     84|| `[[TicketQuery(status=closed,keywords~=opera,or,keywords~=firefox,count)]]` ||
     85|-----------------------------------------------------------
     86||=Number of closed Firefox tickets that don't affect Opera: =||\
     87|| **[[TicketQuery(status=closed,keywords~=firefox - opera,count)]]**||\
     88|| `[[TicketQuery(status=closed,keywords~=firefox -opera,count)]]` ||
    6189|-----------------------------------------------------------
    6290||=Last 3 modified tickets: =||\
    … …  
    78106|-----------------------------------------------------------
    79107
    80 == Using the `[[TicketQuery]]` Macro
     108=== Format: list
    81109
    82 The [trac:TicketQuery TicketQuery] macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.
    83 
    84 Example:
    85110{{{
    86111[[TicketQuery(version=0.6|0.7&resolution=duplicate)]]
    … …  
    90115  [[TicketQuery(version=0.6|0.7&resolution=duplicate)]]
    91116
    92 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:
    93117{{{
    94118[[TicketQuery(id=123)]]
    … …  
    98122  [[TicketQuery(id=123)]]
    99123
    100 A more compact representation without the ticket summaries is:
     124=== Format: compact
     125
    101126{{{
    102127[[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
    … …  
    106131  [[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]
    107132
    108 If you wish to receive only the number of defects that match the query, use the `count` parameter:
     133=== Format: count
     134
    109135{{{
    110136[[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]
    … …  
    114140  [[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]
    115141
    116 A graphical use of the macro is with the `format=progress` attribute:
     142=== Format: progress
     143
    117144{{{
    118145[[TicketQuery(milestone=0.12.8&group=type,format=progress)]]
    119146}}}
    120147
    121 For example for one of the upcoming milestones, bars are shown by ticket type:
    122 [[TicketQuery(milestone=0.12.8&group=type,format=progress)]]
     148This is displayed as:
     149  [[TicketQuery(milestone=0.12.8&group=type,format=progress)]]
     150
     151=== Format: table
     152
     153You 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
     158This 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
     163In ''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
     168This is displayed as:
     169[[TicketQuery(max=3,status=closed,order=id,desc=1,format=table,col=resolution|summary|owner|reporter,rows=description)]]
    123170
    124171----
    125 See also: TracQuery, TracTickets, TracReports, TracGuide
     172See also: TracQuery, TracTickets, TracReports