Changes between Version 3 and Version 4 of TicketStatusQuery


Ignore:
Timestamp:
12/15/08 16:16:51 (4 years ago)
Author:
cbalan
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TicketStatusQuery

    v3 v4  
    22 This widget shows progress bars with ticket counts based on a filter criteria and grouped by a ticket field. The tickets counts will be displayed as closed tickets versus open tickets for every value of the grouping ticket field. Counts will link to the custom query page and pass the appropriate criteria to allow the user to drill down to the details. 
    33 
    4 Syntax: `TicketStatusQuery( <filter in TracQuery syntax>, groupby=CRITERIA, name=Label for widget, format=percent|count, id=widget div id ) ` 
     4Syntax: `TicketStatusQuery( query=<filter in TracQuery syntax>, groupby=<groupby field>, title=<widget's title>)` 
    55 
    6 == Parameters ==  
     6EX: `[[TicketStatusQuery(groupby=component)]]` 
     7[[TicketStatusQuery(groupby=component)]] 
    78 
    8 === Mandatory Parameters === 
    9    * trac query filter - this field it has to have the syntax of the trac query system  
    10    * groupby - it has to contain a ticket field name after the counts are done 
    11  
    12 EX: `[[TicketStatusQuery(milestone=milestone1, groupby=component)]]` 
    13 [[TicketStatusQuery(milestone=milestone1, groupby=component)]] 
    14  
    15 ==== Trac Query Syntax ==== 
    16 The trac ticket query is made of pairs of ticket field names with values separated by & character. 
    17 The trac query contains: 
    18  * ticket fields  
    19  * values - if you have multiple values for one ticket field just separate them by | character 
    20 EX: `[[TicketStatusQuery(milestone=milestone1|milestone2, groupby=component)]]` 
    21 [[TicketStatusQuery(milestone=milestone1|milestone2, groupby=component)]] 
    22  
    23  * operators  
    24    * ! 
    25    * < and > 
    26    * !^ 
    27    * ~ 
    28    * $ 
    29 EX: `[[TicketStatusQuery(milestone=milestone1|milestone2&owner=!rcorsaro, groupby=component)]]` 
    30 [[TicketStatusQuery(milestone=milestone1|milestone2&owner=!rcorsaro, groupby=component)]] 
    31  
    32 ==== Using time variables ==== 
    33 The following variables are implemented: 
    34  * NOW 
    35  * YESTERDAY  
    36  * USER 
    37 EX:`[[TicketStatusQuery(milestone=milestone1|milestone2&owner=$USER, groupby=component, name=Your tickets)]]` 
    38 [[TicketStatusQuery(milestone=milestone1|milestone2&owner=$USER, groupby=component, name=Your tickets)]] 
    39  
    40 This variables were implemented to be used in the filter part of the macro and to put the appropriate value every time the macro is run. 
    41 For more details see TicketCountQuery. 
    42  
    43 === Optional Parameters === 
    44    * name - it must contain a string that will be used as the title of the widget 
    45  
    46    * id - the value of this field will be set as the id of the parent div of the widget. This is for extra inline styling. 
    47    * format - can have two values: `procent` or `count`. The default value is `procent`. This parameter determines the way the values are displayed. 
    48 EX: `[[TicketStatusQuery(milestone=milestone1|milestone2, groupby=component, format=count)]]` 
    49 [[TicketStatusQuery(milestone=milestone1|milestone2, groupby=component, format=count)]] 
    50