Changes between Version 1 and Version 2 of EstimationToolsPlugin


Ignore:
Timestamp:
Sep 24, 2008, 10:10:52 PM (6 years ago)
Author:
hoessler
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • EstimationToolsPlugin

    v1 v2  
    33== Description ==
    44
    5 EstimationTools includes macros that visualize remaining effort estimations, e.g., as Burndown Chart, as well as an extension that allows inline editing of estimations in the query view.
     5!EstimationTools includes macros that visualize remaining effort estimations, e.g., as Burndown Chart, as well as an extension that allows inline editing of estimations in the query view.
     6
     7== Requirements ==
     8
     9The charts use [http://code.google.com/apis/chart/ Google's Chart API], hence no additional python modules are required. The
    610
    711
     
    2226You can check out EstimationToolsPlugin from [http://trac-hacks.org/svn/estimationtoolsplugin here] using Subversion, or [source:estimationtoolsplugin browse the source] with Trac.
    2327
    24 == Example ==
     28== Install ==
     29 
     30 * The latest version for Trac 0.10 can be checked out [http://trac-hacks.org/svn/estimationtoolsplugin/branches/0.10 here].
     31 * Deploy the egg:
     32{{{
     33# python setup.py bdist_egg
     34# cp dist/*.egg /path/to/trac/env/plugins
     35}}}
     36   Please see [http://trac.edgewall.org/wiki/TracPlugins Trac's plug-in installation instructions] for more details.
     37 * You need to add a custom field in your trac.ini to store the estimations for the current remaining effort:
     38{{{
     39estimatedhours = text
     40estimatedhours.label = Remaining Hours
     41estimatedhours.value = 0
     42}}}
     43 * if you want to use another field than {{{estimatedhours}}}, (e.g, {{{hours_remaining}}}), specify it here:
     44{{{
     45[estimation-tools]
     46estimation_field = hours_remaining
     47}}}
     48 * and, finally, enable the plugin
     49{{{
     50[components]
     51estimationtools.* = enabled
     52}}}
     53 
     54== Features ==
    2555
    26 === BurndownChart ===
     56=== !BurndownChart ===
    2757
    2858Creates burn down chart for given milestone.
    2959
    30     This macro creates a chart that can be used to visualize the progress in a milestone (aka sprint or
    31     product backlog).
    32     For a given milestone and time frame, the remaining, estimated effort is calculated.
     60This macro creates a chart that can be used to visualize the progress in a milestone (aka sprint or
     61product backlog).
     62For a given milestone and time frame, the remaining, estimated effort is calculated.
    3363   
    34     The macro has the following parameters:
    35      * `milestone`: '''mandatory''' parameter that specifies the milestone.
    36      * `startdate`: '''mandatory''' parameter that specifies the start date of the period (ISO8601 format)
    37      * `enddate`: end date of the period. If omitted, it defaults to either the milestones `completed' date,
    38        or `due`date, or today (in that order) (ISO8601 format)
    39      * `sprints`: list of comma-separated name of sprints to be included in calculation. Must be surrounded by
    40        brackets.
    41      * `width`: width of resulting diagram (defaults to 800)
    42      * `height`: height of resulting diagram (defaults to 200)
    43      * `color`: color specified as 6-letter string of hexadecimal values in the format `RRGGBB`.
    44        Defaults to `ff9900`, a nice orange.
    45      
    46     Examples:
    47     {{{
    48         [[BurndownChart(milestone = Sprint 1, startdate = 2008-01-01)]]
    49         [[BurndownChart(milestone = Release 3.0, startdate = 2008-01-01, enddate = 2008-01-15,
    50             width = 600, height = 100, color = 0000ff, sprints = (Sprint 1, Sprint 2))]]
    51     }}}
     64The macro has the following parameters:
     65 * `milestone`: '''mandatory''' parameter that specifies the milestone.
     66 * `startdate`: '''mandatory''' parameter that specifies the start date of the period (ISO8601 format)
     67 * `enddate`: end date of the period. If omitted, it defaults to either the milestones `completed' date,
     68   or `due`date, or today (in that order) (ISO8601 format)
     69 * `sprints`: list of comma-separated name of sprints to be included in calculation. Must be surrounded by
     70   brackets.
     71 * `width`: width of resulting diagram (defaults to 800)
     72 * `height`: height of resulting diagram (defaults to 200)
     73 * `color`: color specified as 6-letter string of hexadecimal values in the format `RRGGBB`.
     74   Defaults to `ff9900`, a nice orange.
     75 
     76Examples:
     77{{{
     78[[BurndownChart(milestone = Sprint 1, startdate = 2008-01-01)]]
     79[[BurndownChart(milestone = Release 3.0, startdate = 2008-01-01, enddate = 2008-01-15,
     80width = 600, height = 100, color = 0000ff, sprints = (Sprint 1, Sprint 2))]]
     81}}}
     82
     83=== !HoursRemaining ===
     84
     85Calculates remaining estimated hours for given milestone.
     86
     87`milestone` is a mandatory parameter.
     88   
     89Example:
     90{{{
     91[[HoursRemaining(milestone=Sprint 1)]]
     92}}}
     93
     94=== !WorkloadChart ===
     95
     96Creates workload chart for given milestone.
     97
     98This macro creates a pie chart that shows the remaining estimated workload per ticket owner,
     99and the remaining work days.
     100It has the following parameters:
     101 * `milestone`: '''mandatory''' parameter that specifies the milestone.
     102 * `width`: width of resulting diagram (defaults to 400)
     103 * `height`: height of resulting diagram (defaults to 100)
     104 * `color`: color specified as 6-letter string of hexadecimal values in the format `RRGGBB`.
     105   Defaults to `ff9900`, a nice orange.
     106 
     107Examples:
     108{{{
     109[[WorkloadChart(milestone = Sprint 1)]]
     110[[WorkloadChart(milestone = Sprint 1, width = 600, height = 100, color = 00ff00)]]
     111}}}
     112
     113=== HoursInPlaceEditor ===
     114
     115This component allows to edit the remaining hours field directly in the query view.
    52116
    53117== Recent Changes ==