Changes between Version 31 and Version 32 of EstimationToolsPlugin

Timestamp:

May 10, 2011, 3:47:48 AM (13 years ago)

Author:

Adrian Fritz

Comment:

Finally, details for WorkloadChart macro.

EstimationToolsPlugin

@@ -26 +26 @@
 ||Argument      ||Plugin[[BR]]Version   ||Description   ||Default ||Example
 || `query`|| || a comma-separated list of query parameters for the ticket selection, in the form "key=value" as specified in TracQuery#QueryLanguage. || || `milestone=2011-05,owner=adrian` ||
-|| `startdate`|| || specifies the start date of the period (ISO-8601 format)  '''mandatory''' || || `startdate=2011-05-10` ||
-|| `enddate`|| || end date of the period (ISO8601 format) || In order (defaults on first given): `milestones` or `completed` date, or `due` date, or `today` || `enddate=2011-05-30` ||
+|| `startdate`|| || specifies the start date of the period `[YYYY-MM-DD ISO-8601 format]` '''mandatory''' || || `startdate=2011-05-10` ||
+|| `enddate`|| || end date of the period `[YYYY-MM-DD ISO-8601 format]` || In order (defaults on first given): `milestones` or `completed` date, or `due` date, or `today` || `enddate=2011-05-30` ||
 || `weekends`|| || include weekends in chart `[true, false]` || `true` || `weekends=false` ||
-|| `title`|| || chart title, accepts non ASCII charset (i.e. à, ü, ñ ...) || first milestone or `Burndown Chart` || `title=Estimation Tools Plugin` ||
+|| `title`|| || chart title `[accepts non ASCII charset (i.e. à, ü, ñ ...)]` || first milestone or `Burndown Chart` || `title=Estimation Tools Plugin` ||
 || `expected`|| || show expected progress in chart `[0 or any number to define initial expected hours]`  || `0` || `expected=500` ||
 || `gridlines`|| || show gridlines in chart `[0 or any number to define hour steps]` || `0` || `gridlines=100` ||
@@ -74 +74 @@
 This macro creates a pie chart that shows the remaining estimated workload per ticket owner, and the remaining work days.
 
+{{{
+ [WorkloadChart([<query>,][<width>,][<height>,][<color>])]]
+}}}
+
 ==== Parameters ====
 
 Supports the following parameters:
- * 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)
- * `color`: color specified as 6-letter string of hexadecimal values in the format `RRGGBB`.
-   Defaults to `ff9900`, a nice orange.
+
+||Argument      ||Plugin[[BR]]Version   ||Description   ||Default ||Example
+|| `query`|| || a comma-separated list of query parameters for the ticket selection, in the form "key=value" as specified in TracQuery#QueryLanguage. || || `milestone=2011-05,owner=adrian` ||
+|| `width`|| || width of resulting diagram `[px]` || `400` || `width=450` ||
+|| `height`|| || height of resulting diagram `[px]` || `100` || `height=150` ||
+|| `color`|| || pie chart starting set of color `[RRGGBB]` ||`ff9900` ,,(a nice orange),, ||  `color=00ff00` ||
+ Note ^1^:: argument order it's not important.
+ Note ^2^:: `[RRGGBB]` it's a 6-letter string of hexadecimal values
  
  '''Example:''' :: 
 {{{
-[[WorkloadChart(milestone=Sprint 1)]]
-[[WorkloadChart(milestone=Sprint 1, width=600, height=100, color=00ff00)]]
+[[WorkloadChart(milestone=Sprint 1, width=400, height=100, color=00ff00)]]
 }}}
  '''Results:''' :: 
 {{{
 #!html
-<img src="http://chart.apis.google.com/chart?chs=400x100&chd=t:12,30,22&cht=p3&chtt=Workload%2064h%20(3%20workdays%20left)&chl=Jane%2012h|Peter%2030h|Jack%2022h&chco=ff9900" alt="Workload Chart">
+<img src="http://chart.apis.google.com/chart?chs=400x100&chd=t:12,30,22&cht=p3&chtt=Workload%2064h%20(3%20workdays%20left)&chl=Jane%2012h|Peter%2030h|Jack%2022h&chco=00ff00" alt="Workload Chart">
 }}}