Changes between Version 40 and Version 41 of EstimationToolsPlugin


Ignore:
Timestamp:
Mar 7, 2015, 4:48:10 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with license

Legend:

Unmodified
Added
Removed
Modified
  • EstimationToolsPlugin

    v40 v41  
    11[[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
    1112
    1213Creates burn down chart for selected tickets.
    1314
    14 This macro creates a chart that can be used to visualize the progress in a milestone (e.g., sprint or product backlog).
     15This macro creates a chart that can be used to visualize the progress in a milestone, eg sprint or product backlog.
    1516For a given set of tickets and a time frame, the remaining estimated effort is calculated.
    1617
     
    2021}}}
    2122
    22 ==== Parameters ====
     23==== Parameters
    2324
    2425The macro has the following arguments and parameters:
     
    3839|| `bgcolor`|| || chart drawing area background color `[RRGGBB]` || `ffffff` || `bgcolor=ccee10` ||
    3940|| `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.
    4142 Note ^2^:: `[RRGGBB]` it's a 6-letter string of hexadecimal values
    4243
    4344 '''Examples:''' ::
    4445{{{
    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,
     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,
    4748    weekends=false, expected=100, gridlines=20, width=600, height=100, color=0000ff)]]
    4849}}}
     
    5051{{{
    5152#!comment
    52 Below follows the almost equivalent code for above example
     53Below follows the almost equivalent code for above example:
    5354}}}
    5455{{{
    5556#!html
    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' />
    57 }}}
    58 
    59 === !HoursRemaining ===
     57<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:|2016|2016&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' />
     58}}}
     59
     60=== !HoursRemaining
    6061
    6162Calculates remaining estimated hours for the queried tickets.
     
    7172 '''Results:''' :: Remaining effort to conclude this milestone: '''64''' hs.
    7273
    73 === !WorkloadChart ===
     74=== !WorkloadChart
    7475
    7576Creates workload chart for the selected tickets.
     
    8182}}}
    8283
    83 ==== Parameters ====
     84==== Parameters
    8485
    8586Supports the following parameters:
     
    9091|| `height`|| || height of resulting diagram `[px]` || `100` || `height=150` ||
    9192|| `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.
    9394 Note ^2^:: `[RRGGBB]` it's a 6-letter string of hexadecimal values
    9495 
     
    103104}}}
    104105
    105 === !HoursInPlaceEditor ===
     106=== !HoursInPlaceEditor
    106107
    107108This component allows to edit the remaining hours field directly in the custom query view as well as in the report view.
     
    109110[[Image(HoursInPlaceEditor.png)]]
    110111
     112Notes:
    111113 * to show the remaining hours in the custom query view, you have to enable the corresponding column
    112 
    113114 * 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.
    114115 {{{#!sql
     
    123124        }}}
    124125  * 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
     129Using EstimationToolsPlugin you can schedule tickets of a project with SchedulingToolsPlugin.
     130
     131== Installation
    131132
    132133 1. '''Install'''
     
    135136   1. Manually: Deploy the egg:
    136137  {{{#!sh
    137 $ python setup.py bdist_egg
    138 $ cp dist/*.egg /path/to/trac/env/plugins
     138python setup.py bdist_egg
     139cp dist/*.egg /path/to/trac/env/plugins
    139140}}}
    140141   1. Globally:
    141142 {{{#!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:
     143easy_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:
    145146 {{{#!ini
    146147[ticket-custom]
     
    149150estimatedhours.value = 0
    150151}}}
    151  1. '''Enable''' the plugin by updating TracIni file (..../trac.ini) as follows:
     152 1. '''Enable''' the plugin in the `trac.ini` file:
    152153 {{{#!ini
    153154 [components]
    154155 estimationtools.* = enabled
    155156}}}
    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:
    157158 {{{#!ini
    158159[estimation-tools]
     
    169170 4. '''Restart''' web server on command line:
    170171 {{{#!sh
    171 $ sudo /etc/init.d/apache2 restart
    172 }}}
    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.
     172sudo /etc/init.d/apache2 restart
     173}}}
     174
     175=== Requirements
     176
     177The charts use [http://code.google.com/apis/chart/ Google's Chart API], hence no additional Python modules are required.
    177178
    178179The [EstimationToolsPlugin#HoursInPlaceEditor HoursInPlaceEditor] requires the XmlRpcPlugin.
    179180
    180 === Plugin Installation ===
     181=== Plugin Installation
    181182
    182183Still in doubt? Please see [http://trac.edgewall.org/wiki/TracPlugins Trac's plug-in installation instructions] for more details.
    183184
    184 == Bugs/Feature Requests ==
     185== Bugs/Feature Requests
    185186
    186187Existing bugs and feature requests for EstimationToolsPlugin are
     
    190191[http://trac-hacks.org/newticket?component=EstimationToolsPlugin&owner=hoessler new ticket].
    191192
    192 == Source & Download ==
     193[[TicketQuery(component=EstimationToolsPlugin,group=type,format=progress)]]
     194
     195== Source & Download
    193196
    194197You can check out EstimationToolsPlugin from [http://trac-hacks.org/svn/estimationtoolsplugin here] using Subversion, or [source:estimationtoolsplugin browse the source] with Trac.
     
    202205[http://dl.dropbox.com/u/4213259/deb/trac-estimationtools_0.4.5-1.dsc dsc]).
    203206
    204 === Recent Changes ===
     207=== Recent Changes
    205208
    206209[[ChangeLog(estimationtoolsplugin, 3)]]
    207210
    208 == Author/Contributors ==
     211== Author/Contributors
    209212
    210213'''Author:''' [wiki:hoessler] [[BR]]
    211 '''Maintainer:''' [wiki:hoessler] [[BR]]
     214'''Maintainer:''' [[Maintainer]] [[BR]]
    212215'''Contributors:''' [wiki:osimons]