Changes between Version 40 and Version 41 of EstimationToolsPlugin
- Timestamp:
- Mar 7, 2015, 4:48:10 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
EstimationToolsPlugin
v40 v41 1 1 [[PageOutline(2-5,Contents,pullout)]] 2 = Tools for visualizing and quick editing of effort estimations = 3 4 == Description == 5 6 !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. 7 8 == Usage == 9 10 === !BurndownChart === 2 3 = Tools for visualizing and quick editing of effort estimations 4 5 == Description 6 7 !EstimationTools includes macros that visualize remaining effort estimations, eg Burndown Charts, as well as an extension that allows inline editing of estimations in the query view. 8 9 == Usage 10 11 === !BurndownChart 11 12 12 13 Creates burn down chart for selected tickets. 13 14 14 This macro creates a chart that can be used to visualize the progress in a milestone (e.g., sprint or product backlog).15 This macro creates a chart that can be used to visualize the progress in a milestone, eg sprint or product backlog. 15 16 For a given set of tickets and a time frame, the remaining estimated effort is calculated. 16 17 … … 20 21 }}} 21 22 22 ==== Parameters ====23 ==== Parameters 23 24 24 25 The macro has the following arguments and parameters: … … 38 39 || `bgcolor`|| || chart drawing area background color `[RRGGBB]` || `ffffff` || `bgcolor=ccee10` || 39 40 || `wecolor`|| || chart drawing area background color for weekends `[RRGGBB]` ||`cccccc` || `wecolor=10bb20` || 40 Note ^1^:: argument order it's not important.41 Note ^1^:: The arguments can be given in any order. 41 42 Note ^2^:: `[RRGGBB]` it's a 6-letter string of hexadecimal values 42 43 43 44 '''Examples:''' :: 44 45 {{{ 45 [[BurndownChart(milestone=Sprint 1, startdate=201 1-01-01)]]46 [[BurndownChart(milestone=Release 3.0|Sprint 1, startdate=201 1-01-01, enddate=2011-01-15,46 [[BurndownChart(milestone=Sprint 1, startdate=2016-01-01)]] 47 [[BurndownChart(milestone=Release 3.0|Sprint 1, startdate=2016-01-01, enddate=2016-01-15, 47 48 weekends=false, expected=100, gridlines=20, width=600, height=100, color=0000ff)]] 48 49 }}} … … 50 51 {{{ 51 52 #!comment 52 Below follows the almost equivalent code for above example 53 Below follows the almost equivalent code for above example: 53 54 }}} 54 55 {{{ 55 56 #!html 56 <img src="http://chart.apis.google.com/chart?chs=800x200&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&cht=lxy&chxt=x,x,x,y&chxl=0:|15|16|17|18|19|20|21|22|23|24|25|26|1:|9|9|2:|201 1|2011&chxr=3,0,143.0&chm=R,f1f1f1,0,0.40909090909,0.59090909091&chg=100.0,100.0,1,0&chco=ff9900&chtt=Current Sprint" alt='Burndown Chart' />57 }}} 58 59 === !HoursRemaining ===57 <img src="http://chart.apis.google.com/chart?chs=800x200&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&cht=lxy&chxt=x,x,x,y&chxl=0:|15|16|17|18|19|20|21|22|23|24|25|26|1:|9|9|2:|2016|2016&chxr=3,0,143.0&chm=R,f1f1f1,0,0.40909090909,0.59090909091&chg=100.0,100.0,1,0&chco=ff9900&chtt=Current Sprint" alt='Burndown Chart' /> 58 }}} 59 60 === !HoursRemaining 60 61 61 62 Calculates remaining estimated hours for the queried tickets. … … 71 72 '''Results:''' :: Remaining effort to conclude this milestone: '''64''' hs. 72 73 73 === !WorkloadChart ===74 === !WorkloadChart 74 75 75 76 Creates workload chart for the selected tickets. … … 81 82 }}} 82 83 83 ==== Parameters ====84 ==== Parameters 84 85 85 86 Supports the following parameters: … … 90 91 || `height`|| || height of resulting diagram `[px]` || `100` || `height=150` || 91 92 || `color`|| || pie chart starting set of color `[RRGGBB]` ||`ff9900` ,,(a nice orange),, || `color=00ff00` || 92 Note ^1^:: argument order it's not important.93 Note ^1^:: The arguments can be given in any order. 93 94 Note ^2^:: `[RRGGBB]` it's a 6-letter string of hexadecimal values 94 95 … … 103 104 }}} 104 105 105 === !HoursInPlaceEditor ===106 === !HoursInPlaceEditor 106 107 107 108 This component allows to edit the remaining hours field directly in the custom query view as well as in the report view. … … 109 110 [[Image(HoursInPlaceEditor.png)]] 110 111 112 Notes: 111 113 * to show the remaining hours in the custom query view, you have to enable the corresponding column 112 113 114 * if you want to show the remaining hours column in your SQL reports, you need to join the ticket table with the ticket_custom table, which contains the custom fields. 114 115 {{{#!sql … … 123 124 }}} 124 125 * You could change {{{''}}} to '0' to show 0 hours for tickets that don't have a corresponding estimated hours field. 125 * Tickets may have an estimated hours field that is empty, in which case you may still see "blank" 126 * See #4549 for a more complex example 127 128 viola: Using EstimationToolsPlugin, one can schedule tickets of a project with SchedulingToolsPlugin - try it! 129 130 == Install ==126 * Tickets may have an estimated hours field that is empty, in which case you may still see "blank". 127 * See #4549 for a more complex example. 128 129 Using EstimationToolsPlugin you can schedule tickets of a project with SchedulingToolsPlugin. 130 131 == Installation 131 132 132 133 1. '''Install''' … … 135 136 1. Manually: Deploy the egg: 136 137 {{{#!sh 137 $python setup.py bdist_egg138 $cp dist/*.egg /path/to/trac/env/plugins138 python setup.py bdist_egg 139 cp dist/*.egg /path/to/trac/env/plugins 139 140 }}} 140 141 1. Globally: 141 142 {{{#!sh 142 $easy_install https://trac-hacks.org/svn/estimationtoolsplugin/trunk/143 }}} 144 1. '''Add''' a custom field into 'trac.ini' file to store the estimations for the current remaining effort, as follows:143 easy_install https://trac-hacks.org/svn/estimationtoolsplugin/trunk/ 144 }}} 145 1. '''Add''' a custom field to the `trac.ini` file to store the estimations for the current remaining effort: 145 146 {{{#!ini 146 147 [ticket-custom] … … 149 150 estimatedhours.value = 0 150 151 }}} 151 1. '''Enable''' the plugin by updating TracIni file (..../trac.ini) as follows:152 1. '''Enable''' the plugin in the `trac.ini` file: 152 153 {{{#!ini 153 154 [components] 154 155 estimationtools.* = enabled 155 156 }}} 156 1. '''Configure''' the plugin at its own configuration section , placed into 'trac.ini' file as follows:157 1. '''Configure''' the plugin at its own configuration section in the `trac.ini` file: 157 158 {{{#!ini 158 159 [estimation-tools] … … 169 170 4. '''Restart''' web server on command line: 170 171 {{{#!sh 171 $sudo /etc/init.d/apache2 restart172 }}} 173 174 === Requirements ===175 176 The charts use [http://code.google.com/apis/chart/ Google's Chart API], hence no additional python modules are required.172 sudo /etc/init.d/apache2 restart 173 }}} 174 175 === Requirements 176 177 The charts use [http://code.google.com/apis/chart/ Google's Chart API], hence no additional Python modules are required. 177 178 178 179 The [EstimationToolsPlugin#HoursInPlaceEditor HoursInPlaceEditor] requires the XmlRpcPlugin. 179 180 180 === Plugin Installation ===181 === Plugin Installation 181 182 182 183 Still in doubt? Please see [http://trac.edgewall.org/wiki/TracPlugins Trac's plug-in installation instructions] for more details. 183 184 184 == Bugs/Feature Requests ==185 == Bugs/Feature Requests 185 186 186 187 Existing bugs and feature requests for EstimationToolsPlugin are … … 190 191 [http://trac-hacks.org/newticket?component=EstimationToolsPlugin&owner=hoessler new ticket]. 191 192 192 == Source & Download == 193 [[TicketQuery(component=EstimationToolsPlugin,group=type,format=progress)]] 194 195 == Source & Download 193 196 194 197 You can check out EstimationToolsPlugin from [http://trac-hacks.org/svn/estimationtoolsplugin here] using Subversion, or [source:estimationtoolsplugin browse the source] with Trac. … … 202 205 [http://dl.dropbox.com/u/4213259/deb/trac-estimationtools_0.4.5-1.dsc dsc]). 203 206 204 === Recent Changes ===207 === Recent Changes 205 208 206 209 [[ChangeLog(estimationtoolsplugin, 3)]] 207 210 208 == Author/Contributors ==211 == Author/Contributors 209 212 210 213 '''Author:''' [wiki:hoessler] [[BR]] 211 '''Maintainer:''' [ wiki:hoessler] [[BR]]214 '''Maintainer:''' [[Maintainer]] [[BR]] 212 215 '''Contributors:''' [wiki:osimons]