Changes between Version 29 and Version 30 of EstimationToolsPlugin


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

Work-in-process. Details for BurndownChart macro.

Legend:

Unmodified
Added
Removed
Modified
  • EstimationToolsPlugin

    v29 v30  
    1616
    1717{{{
    18 [[BurndownChart([<query>,<startdate>,[<enddate>,[<weekends>,[<title>,[<expected>,[<gridlines>,
    19       [<width>,[<height>],[<color>],[<colorexpected>],[<bgcolor>],[<wecolor>]]]]]]]])]]
     18[[BurndownChart([<query>,]<startdate>,[<enddate>,][<weekends>,][<title>,][<expected>,][<gridlines>,]
     19      [<width>,][<height>,][<color>,][<colorexpected>,][<bgcolor>,][<wecolor>])]]
    2020}}}
    2121
    2222==== Parameters ====
    2323
    24 The macro has the following parameters:
    25 ||Argument      ||Version       ||Description   ||Default
    26 || `query`|| || a comma-separated list of query parameters for the ticket selection, in the form "key=value" as specified in TracQuery#QueryLanguage. || ||
    27 || `startdate`|| || '''mandatory''' parameter that specifies the start date of the period (ISO8601 format)
    28 || `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)
    29 || `weekends`|| || include weekends in chart. || `true`
    30 || `title`|| || chart title. || first milestone or 'Burndown Chart'
    31 || `expected`|| || show expected progress in chart, 0 or any number to define initial expected hours  || 0
    32 || `gridlines`|| || show gridlines in chart, 0 or any number to define hour steps || 0)
    33 || `width`|| || width of resulting diagram || 800)
    34 || `height`|| || height of resulting diagram || 200)
    35 || `color`|| || color specified as 6-letter string of hexadecimal values in the format `RRGGBB`. ||`ff9900`, a nice orange.
    36 || `colorexpected`|| || color for expected hours graph specified as 6-letter string of hexadecimal values in the format `RRGGBB`. ||ffddaa, a nice yellow.
    37 || `bgcolor`|| || chart drawing area background color specified as 6-letter string of hexadecimal values in the format `RRGGBB`. ||`ffffff`.
    38 || `wecolor`|| || chart drawing area background color for weekends specified as 6-letter string of hexadecimal values in the format `RRGGBB`. ||`ccccccaa`.
     24The macro has the following arguments and parameters:
     25
     26||Argument      ||Plugin[[BR]]Version   ||Description   ||Default ||Example
     27|| `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` ||
     30|| `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` ||
     32|| `expected`|| || show expected progress in chart `[0 or any number to define initial expected hours]`  || `0` || `expected=500` ||
     33|| `gridlines`|| || show gridlines in chart `[0 or any number to define hour steps]` || `0` || `gridlines=100` ||
     34|| `width`|| || width of resulting diagram `[px]` || `800` || `width=450` ||
     35|| `height`|| || height of resulting diagram `[px]` || `200` || `height=150` ||
     36|| `color`|| || burn down graph color `[RRGGBB]` ||`ff9900` ,,(a nice orange),, ||  `color=0099ff` ||
     37|| `colorexpected`|| || color for expected hours graph `[RRGGBB]` || `ffddaa` ,,(a nice yellow),, || `colorexpected=ddffdd` ||
     38|| `bgcolor`|| || chart drawing area background color `[RRGGBB]` || `ffffff` || `bgcolor=ccee10` ||
     39|| `wecolor`|| || chart drawing area background color for weekends `[RRGGBB]` ||`cccccc` || `wecolor=10bb20` ||
     40 Note ^1^:: argument order it's not important.
     41 Note ^2^:: `[RRGGBB]` it's a 6-letter string of hexadecimal values
    3942
    4043Examples:
    4144{{{
    42 [[BurndownChart(milestone=Sprint 1, startdate=2008-01-01)]]
    43 [[BurndownChart(milestone=Release 3.0|Sprint 1, startdate=2008-01-01, enddate=2008-01-15,
     45[[BurndownChart(milestone=Sprint 1, startdate=2011-01-01)]]
     46[[BurndownChart(milestone=Release 3.0|Sprint 1, startdate=2011-01-01, enddate=2011-01-15,
    4447   weekends=false, expected=100, gridlines=20, width=600, height=100, color=0000ff)]]
    4548}}}
     
    5154{{{
    5255#!html
    53 <img src="http://chart.apis.google.com/chart?chs=800x200&amp;chd=t:0.0,9.09090909091,18.1818181818,27.2727272727,36.3636363636,45.4545454545,54.5454545455,63.6363636364,72.7272727273,81.8181818182,90.9090909091,100.0|81.0,100.0,99.0,100.0,94.4055944056,85.4055944056,72.4055944056,65.4055944056,62.4055944056,43.4055944056,-1,-1&amp;cht=lxy&amp;chxt=x,x,x,y&amp;chxl=0:|15|16|17|18|19|20|21|22|23|24|25|26|1:|9|9|2:|2008|2008&amp;chxr=3,0,143.0&amp;chm=R,f1f1f1,0,0.40909090909,0.59090909091&amp;chg=100.0,100.0,1,0&amp;chco=ff9900&amp;chtt=Current Sprint" alt='Burndown Chart' />
     56<img src="http://chart.apis.google.com/chart?chs=800x200&amp;chd=t:0.0,9.09090909091,18.1818181818,27.2727272727,36.3636363636,45.4545454545,54.5454545455,63.6363636364,72.7272727273,81.8181818182,90.9090909091,100.0|81.0,100.0,99.0,100.0,94.4055944056,85.4055944056,72.4055944056,65.4055944056,62.4055944056,43.4055944056,-1,-1&amp;cht=lxy&amp;chxt=x,x,x,y&amp;chxl=0:|15|16|17|18|19|20|21|22|23|24|25|26|1:|9|9|2:|2011|2011&amp;chxr=3,0,143.0&amp;chm=R,f1f1f1,0,0.40909090909,0.59090909091&amp;chg=100.0,100.0,1,0&amp;chco=ff9900&amp;chtt=Current Sprint" alt='Burndown Chart' />
    5457}}}
    5558