Changes between Version 28 and Version 29 of EstimationToolsPlugin


Ignore:
Timestamp:
May 8, 2011, 3:55:54 PM (3 years ago)
Author:
AdrianFritz
Comment:

Work-in-process. Restructuring page. Tag it for 0.12. Starts to D.R.Y.

Legend:

Unmodified
Added
Removed
Modified
  • EstimationToolsPlugin

    v28 v29  
    66!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.
    77
    8 == Requirements ==
    9 
    10 The charts use [http://code.google.com/apis/chart/ Google's Chart API], hence no additional python modules are required. The [EstimationToolsPlugin#HoursInPlaceEditor HoursInPlaceEditor] requires the XmlRpcPlugin.
    11 
    12 == Bugs/Feature Requests ==
    13 
    14 Existing bugs and feature requests for EstimationToolsPlugin are
    15 [report:9?COMPONENT=EstimationToolsPlugin here].
    16 
    17 If you have any issues, create a
    18 [http://trac-hacks.org/newticket?component=EstimationToolsPlugin&owner=hoessler new ticket].
    19 
    20 == Download ==
    21 
    22 Download the zipped source from [download:estimationtoolsplugin here].
    23 
    24 == Source ==
    25 
    26 You can check out EstimationToolsPlugin from [http://trac-hacks.org/svn/estimationtoolsplugin here] using Subversion, or [source:estimationtoolsplugin browse the source] with Trac.
    27 
    28 == Install ==
    29  
    30  * Trac 0.11.x and Trac 0.12.x is supported in [http://trac-hacks.org/svn/estimationtoolsplugin/trunk trunk].
    31  * The latest version for Trac 0.10 can be checked out [http://trac-hacks.org/svn/estimationtoolsplugin/branches/0.10 here].
    32  * Deploy the egg:
    33 {{{
    34 # python setup.py bdist_egg
    35 # cp dist/*.egg /path/to/trac/env/plugins
    36 }}}
    37    Please see [http://trac.edgewall.org/wiki/TracPlugins Trac's plug-in installation instructions] for more details.
    38  * You need to add a custom field in your trac.ini to store the estimations for the current remaining effort:
    39 {{{
    40 [ticket-custom]
    41 estimatedhours = text
    42 estimatedhours.label = Remaining Hours
    43 estimatedhours.value = 0
    44 }}}
    45  * enable the plugin
    46 {{{
    47 [components]
    48 estimationtools.* = enabled
    49 }}}
    50  * further configurations go here
    51 {{{
    52 [estimation-tools]
    53 # if you want to use another field than estimatedhours you can change that
    54 estimation_field = estimatedhours
    55 # Set to a comma separated list of workflow states
    56 # that count as zero in BurnDownChart. Defaults to 'closed'
    57 closed_states = closed,another_state 
    58 # Suffix used for estimations. Defaults to 'h'
    59 estimation_suffix = points       
    60 # If you want charts to be served from the server set to true. Useful for SSL connections. Default 'false'
    61 serverside_charts = false
    62 }}}
    63  
    64 == Features ==
     8== Usage ==
    659
    6610=== !BurndownChart ===
     
    6812Creates burn down chart for selected tickets.
    6913
    70 This macro creates a chart that can be used to visualize the progress in a milestone (e.g., sprint or
    71 product backlog).
     14This macro creates a chart that can be used to visualize the progress in a milestone (e.g., sprint or product backlog).
    7215For a given set of tickets and a time frame, the remaining estimated effort is calculated.
    73    
     16
     17{{{
     18[[BurndownChart([<query>,<startdate>,[<enddate>,[<weekends>,[<title>,[<expected>,[<gridlines>,
     19      [<width>,[<height>],[<color>],[<colorexpected>],[<bgcolor>],[<wecolor>]]]]]]]])]]
     20}}}
     21
     22==== Parameters ====
     23
    7424The macro has the following parameters:
    75  * a comma-separated list of query parameters for the ticket selection, in the form "key=value" as specified in TracQuery#QueryLanguage.
    76  * `startdate`: '''mandatory''' parameter that specifies the start date of the period (ISO8601 format)
    77  * `enddate`: end date of the period. If omitted, it defaults to either the milestones (if given) `completed' date,
    78    or `due` date, or today (in that order) (ISO8601 format)
    79  * `weekends`: include weekends in chart. Defaults to `true`
    80  * `title`: chart title. Defaults to first milestone or 'Burndown Chart'
    81  * `expected`: show expected progress in chart, 0 or any number to define initial expected hours (defaults to 0).
    82  * `gridlines`: show gridlines in chart, 0 or any number to define hour steps (defaults to 0)
    83  * `width`: width of resulting diagram (defaults to 800)
    84  * `height`: height of resulting diagram (defaults to 200)
    85  * `color`: color specified as 6-letter string of hexadecimal values in the format `RRGGBB`.
    86    Defaults to `ff9900`, a nice orange.
    87  * `colorexpected`: color for expected hours graph specified as 6-letter string of hexadecimal values in the format `RRGGBB`.
    88    Defaults to ffddaa, a nice yellow.
    89  * `bgcolor`: chart drawing area background color specified as 6-letter string of hexadecimal values in the format `RRGGBB`.
    90    Defaults to `ffffff`.
    91  * `wecolor`: chart drawing area background color for weekends specified as 6-letter string of hexadecimal values in the format `RRGGBB`.
    92    Defaults to `ccccccaa`.
     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`.
    9339
    9440Examples:
     
    10046
    10147{{{
     48#!comment
     49Below follows the almost equivalent code for above example
     50}}}
     51{{{
    10252#!html
    10353<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' />
     
    10858Calculates remaining estimated hours for the queried tickets.
    10959
    110 The macro accepts a comma-separated list of query parameters for the ticket selection,
    111 in the form "key=value" as specified in TracQuery#QueryLanguage.
     60The macro accepts a comma-separated list of query parameters for the ticket selection, in the form "key=value" as specified in TracQuery#QueryLanguage.
    11261   
    11362Example:
     
    11665}}}
    11766
     67=== !WorkloadChart ===
    11868
    119 === !WorkloadChart ===
    12069Creates workload chart for the selected tickets.
    12170
    122 This macro creates a pie chart that shows the remaining estimated workload per ticket owner,
    123 and the remaining work days.
    124 It has the following parameters:
     71This macro creates a pie chart that shows the remaining estimated workload per ticket owner, and the remaining work days.
     72
     73==== Parameters ====
     74
     75Supports the following parameters:
    12576 * a comma-separated list of query parameters for the ticket selection, in the form "key=value" as specified in TracQuery#QueryLanguage.
    12677 * `width`: width of resulting diagram (defaults to 400)
     
    165116viola: Using EstimationToolsPlugin, one can schedule tickets of a project with SchedulingToolsPlugin - try it!
    166117
    167 == Recent Changes ==
     118== Install ==
     119
     120 1. '''Install'''
     121    * Trac 0.11.x and Trac 0.12.x is supported in [http://trac-hacks.org/svn/estimationtoolsplugin/trunk trunk].
     122    * The latest version for Trac 0.10 can be checked out [http://trac-hacks.org/svn/estimationtoolsplugin/branches/0.10 here].
     123    1. Manually: Deploy the egg:
     124{{{
     125#!sh
     126   $ python setup.py bdist_egg
     127   $ cp dist/*.egg /path/to/trac/env/plugins
     128}}}
     129    1. Globally:
     130{{{
     131#!sh
     132   $ easy_install https://trac-hacks.org/svn/estimationtoolsplugin/trunk/
     133}}}
     134 1. '''Add''' a custom field into 'trac.ini' file to store the estimations for the current remaining effort, as follows:
     135{{{
     136[ticket-custom]
     137estimatedhours = text
     138estimatedhours.label = Remaining Hours
     139estimatedhours.value = 0
     140}}}
     141 1. '''Enable''' the plugin by updating TracIni file (..../trac.ini) as follows:
     142{{{
     143 [components]
     144 estimationtools.* = enabled
     145}}}
     146 1. '''Configure''' the plugin at its own configuration section, placed into 'trac.ini' file as follows:
     147{{{
     148[estimation-tools]
     149# if you want to use another field than estimatedhours you can change that
     150estimation_field = estimatedhours
     151# Set to a comma separated list of workflow states
     152# that count as zero in BurnDownChart. Defaults to 'closed'
     153closed_states = closed,another_state 
     154# Suffix used for estimations. Defaults to 'h'
     155estimation_suffix = points       
     156# If you want charts to be served from the server set to true. Useful for SSL connections. Default 'false'
     157serverside_charts = false
     158}}}
     159 4. '''Restart''' web server on command line:
     160{{{
     161#!sh
     162   $ sudo /etc/init.d/apache2 restart
     163}}}
     164=== Requirements ===
     165
     166The charts use [http://code.google.com/apis/chart/ Google's Chart API], hence no additional python modules are required.
     167
     168The [EstimationToolsPlugin#HoursInPlaceEditor HoursInPlaceEditor] requires the XmlRpcPlugin.
     169
     170=== Plugin Installation ===
     171
     172Still in doubt? Please see [http://trac.edgewall.org/wiki/TracPlugins Trac's plug-in installation instructions] for more details.
     173
     174== Bugs/Feature Requests ==
     175
     176Existing bugs and feature requests for EstimationToolsPlugin are
     177[report:9?COMPONENT=EstimationToolsPlugin here].
     178
     179If you have any issues, create a
     180[http://trac-hacks.org/newticket?component=EstimationToolsPlugin&owner=hoessler new ticket].
     181
     182=== Known issues ===
     183
     184=== Planned enhancements ===
     185
     186== Source & Download ==
     187
     188You can check out EstimationToolsPlugin from [http://trac-hacks.org/svn/estimationtoolsplugin here] using Subversion, or [source:estimationtoolsplugin browse the source] with Trac.
     189
     190Download the zipped source from [download:estimationtoolsplugin here].
     191
     192=== Recent Changes ===
    168193
    169194[[ChangeLog(estimationtoolsplugin, 3)]]