Changes between Version 8 and Version 9 of EstimationToolsPlugin

Timestamp:

Oct 12, 2008, 10:28:09 PM (16 years ago)

Author:

Joachim Hoessler

Comment:

--

EstimationToolsPlugin

@@ -57 +57 @@
 === !BurndownChart ===
 
-Creates burn down chart for given milestone.
+Creates burn down chart for selected tickets.
 
-This macro creates a chart that can be used to visualize the progress in a milestone (aka sprint or 
+This macro creates a chart that can be used to visualize the progress in a milestone (e.g., sprint or 
 product backlog). 
-For a given milestone and time frame, the remaining, estimated effort is calculated.
+For a given set of tickets and a time frame, the remaining estimated effort is calculated.
     
 The macro has the following parameters:
- * `milestone`: '''mandatory''' parameter that specifies the milestone.
+ * a comma-separated list of query parameters for the ticket selection, in the form "key=value" as specified in TracQuery#QueryLanguage.
  * `startdate`: '''mandatory''' parameter that specifies the start date of the period (ISO8601 format)
- * `enddate`: end date of the period. If omitted, it defaults to either the milestones `completed' date, 
+ * `enddate`: end date of the period. If omitted, it defaults to either the milestones (if given) `completed' date, 
    or `due`date, or today (in that order) (ISO8601 format)
- * `sprints`: list of comma-separated name of sprints to be included in calculation. Must be surrounded by
-   brackets.
  * `width`: width of resulting diagram (defaults to 800)
  * `height`: height of resulting diagram (defaults to 200)
@@ -77 +75 @@
 Examples:
 {{{
-[[BurndownChart(milestone = Sprint 1, startdate = 2008-01-01)]]
-[[BurndownChart(milestone = Release 3.0, startdate = 2008-01-01, enddate = 2008-01-15,
-width = 600, height = 100, color = 0000ff, sprints = (Sprint 1, Sprint 2))]]
+[[BurndownChart(milestone=Sprint 1, startdate=2008-01-01)]]
+[[BurndownChart(milestone=Release 3.0|Sprint 1, startdate=2008-01-01, enddate=2008-01-15,
+            width=600, height=100, color=0000ff)]]
 }}}
 
@@ -89 +87 @@
 === !HoursRemaining ===
 
-Calculates remaining estimated hours for given milestone.
+Calculates remaining estimated hours for the queried tickets.
 
-`milestone` is a mandatory parameter.
+The macro accepts a comma-separated list of query parameters for the ticket selection, 
+in the form "key=value" as specified in TracQuery#QueryLanguage.
     
 Example:
@@ -100 +99 @@
 
 === !WorkloadChart ===
-
-Creates workload chart for given milestone.
+Creates workload chart for the selected tickets.
 
 This macro creates a pie chart that shows the remaining estimated workload per ticket owner,
 and the remaining work days.
 It has the following parameters:
- * `milestone`: '''mandatory''' parameter that specifies the milestone. 
+ * a comma-separated list of query parameters for the ticket selection, in the form "key=value" as specified in TracQuery#QueryLanguage.
  * `width`: width of resulting diagram (defaults to 400)
  * `height`: height of resulting diagram (defaults to 100)
@@ -114 +112 @@
 Examples:
 {{{
-[[WorkloadChart(milestone = Sprint 1)]]
-[[WorkloadChart(milestone = Sprint 1, width = 600, height = 100, color = 00ff00)]]
+[[WorkloadChart(milestone=Sprint 1)]]
+[[WorkloadChart(milestone=Sprint 1, width=600, height=100, color=00ff00)]]
 }}}