Changes between Version 8 and Version 9 of EstimationToolsPlugin


Ignore:
Timestamp:
Oct 13, 2008 12:28:09 AM (6 years ago)
Author:
hoessler
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • EstimationToolsPlugin

    v8 v9  
    5757=== !BurndownChart === 
    5858 
    59 Creates burn down chart for given milestone. 
     59Creates burn down chart for selected tickets. 
    6060 
    61 This macro creates a chart that can be used to visualize the progress in a milestone (aka sprint or  
     61This macro creates a chart that can be used to visualize the progress in a milestone (e.g., sprint or  
    6262product backlog).  
    63 For a given milestone and time frame, the remaining, estimated effort is calculated. 
     63For a given set of tickets and a time frame, the remaining estimated effort is calculated. 
    6464     
    6565The macro has the following parameters: 
    66  * `milestone`: '''mandatory''' parameter that specifies the milestone. 
     66 * a comma-separated list of query parameters for the ticket selection, in the form "key=value" as specified in TracQuery#QueryLanguage. 
    6767 * `startdate`: '''mandatory''' parameter that specifies the start date of the period (ISO8601 format) 
    68  * `enddate`: end date of the period. If omitted, it defaults to either the milestones `completed' date,  
     68 * `enddate`: end date of the period. If omitted, it defaults to either the milestones (if given) `completed' date,  
    6969   or `due`date, or today (in that order) (ISO8601 format) 
    70  * `sprints`: list of comma-separated name of sprints to be included in calculation. Must be surrounded by 
    71    brackets. 
    7270 * `width`: width of resulting diagram (defaults to 800) 
    7371 * `height`: height of resulting diagram (defaults to 200) 
     
    7775Examples: 
    7876{{{ 
    79 [[BurndownChart(milestone = Sprint 1, startdate = 2008-01-01)]] 
    80 [[BurndownChart(milestone = Release 3.0, startdate = 2008-01-01, enddate = 2008-01-15, 
    81 width = 600, height = 100, color = 0000ff, sprints = (Sprint 1, Sprint 2))]] 
     77[[BurndownChart(milestone=Sprint 1, startdate=2008-01-01)]] 
     78[[BurndownChart(milestone=Release 3.0|Sprint 1, startdate=2008-01-01, enddate=2008-01-15, 
     79            width=600, height=100, color=0000ff)]] 
    8280}}} 
    8381 
     
    8987=== !HoursRemaining === 
    9088 
    91 Calculates remaining estimated hours for given milestone. 
     89Calculates remaining estimated hours for the queried tickets. 
    9290 
    93 `milestone` is a mandatory parameter. 
     91The macro accepts a comma-separated list of query parameters for the ticket selection,  
     92in the form "key=value" as specified in TracQuery#QueryLanguage. 
    9493     
    9594Example: 
     
    10099 
    101100=== !WorkloadChart === 
    102  
    103 Creates workload chart for given milestone. 
     101Creates workload chart for the selected tickets. 
    104102 
    105103This macro creates a pie chart that shows the remaining estimated workload per ticket owner, 
    106104and the remaining work days. 
    107105It has the following parameters: 
    108  * `milestone`: '''mandatory''' parameter that specifies the milestone.  
     106 * a comma-separated list of query parameters for the ticket selection, in the form "key=value" as specified in TracQuery#QueryLanguage. 
    109107 * `width`: width of resulting diagram (defaults to 400) 
    110108 * `height`: height of resulting diagram (defaults to 100) 
     
    114112Examples: 
    115113{{{ 
    116 [[WorkloadChart(milestone = Sprint 1)]] 
    117 [[WorkloadChart(milestone = Sprint 1, width = 600, height = 100, color = 00ff00)]] 
     114[[WorkloadChart(milestone=Sprint 1)]] 
     115[[WorkloadChart(milestone=Sprint 1, width=600, height=100, color=00ff00)]] 
    118116}}} 
    119117