Changes between Version 31 and Version 32 of EstimationToolsPlugin


Ignore:
Timestamp:
May 10, 2011, 5:47:48 AM (4 years ago)
Author:
AdrianFritz
Comment:

Finally, details for WorkloadChart macro.

Legend:

Unmodified
Added
Removed
Modified
  • EstimationToolsPlugin

    v31 v32  
    2626||Argument      ||Plugin[[BR]]Version   ||Description   ||Default ||Example
    2727|| `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` ||
    28 || `startdate`|| || specifies the start date of the period (ISO-8601 format) '''mandatory''' || || `startdate=2011-05-10` ||
    29 || `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` ||
     28|| `startdate`|| || specifies the start date of the period `[YYYY-MM-DD ISO-8601 format]` '''mandatory''' || || `startdate=2011-05-10` ||
     29|| `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` ||
    3030|| `weekends`|| || include weekends in chart `[true, false]` || `true` || `weekends=false` ||
    31 || `title`|| || chart title, accepts non ASCII charset (i.e. à, ü, ñ ...) || first milestone or `Burndown Chart` || `title=Estimation Tools Plugin` ||
     31|| `title`|| || chart title `[accepts non ASCII charset (i.e. à, ü, ñ ...)]` || first milestone or `Burndown Chart` || `title=Estimation Tools Plugin` ||
    3232|| `expected`|| || show expected progress in chart `[0 or any number to define initial expected hours]`  || `0` || `expected=500` ||
    3333|| `gridlines`|| || show gridlines in chart `[0 or any number to define hour steps]` || `0` || `gridlines=100` ||
     
    7474This macro creates a pie chart that shows the remaining estimated workload per ticket owner, and the remaining work days.
    7575
     76{{{
     77 [WorkloadChart([<query>,][<width>,][<height>,][<color>])]]
     78}}}
     79
    7680==== Parameters ====
    7781
    7882Supports the following parameters:
    79  * a comma-separated list of query parameters for the ticket selection, in the form "key=value" as specified in TracQuery#QueryLanguage.
    80  * `width`: width of resulting diagram (defaults to 400)
    81  * `height`: height of resulting diagram (defaults to 100)
    82  * `color`: color specified as 6-letter string of hexadecimal values in the format `RRGGBB`.
    83    Defaults to `ff9900`, a nice orange.
     83
     84||Argument      ||Plugin[[BR]]Version   ||Description   ||Default ||Example
     85|| `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` ||
     86|| `width`|| || width of resulting diagram `[px]` || `400` || `width=450` ||
     87|| `height`|| || height of resulting diagram `[px]` || `100` || `height=150` ||
     88|| `color`|| || pie chart starting set of color `[RRGGBB]` ||`ff9900` ,,(a nice orange),, ||  `color=00ff00` ||
     89 Note ^1^:: argument order it's not important.
     90 Note ^2^:: `[RRGGBB]` it's a 6-letter string of hexadecimal values
    8491 
    8592 '''Example:''' ::
    8693{{{
    87 [[WorkloadChart(milestone=Sprint 1)]]
    88 [[WorkloadChart(milestone=Sprint 1, width=600, height=100, color=00ff00)]]
     94[[WorkloadChart(milestone=Sprint 1, width=400, height=100, color=00ff00)]]
    8995}}}
    9096 '''Results:''' ::
    9197{{{
    9298#!html
    93 <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">
     99<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">
    94100}}}
    95101