Changes between Version 41 and Version 42 of EstimationToolsPlugin


Ignore:
Timestamp:
Aug 20, 2015, 9:32:30 AM (9 years ago)
Author:
figaro
Comment:

Rearranged paragraphs to maintain consistency, further cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • EstimationToolsPlugin

    v41 v42  
    55== Description
    66
    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
     7This plugin 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.
    108
    119=== !BurndownChart
    … …  
    1715
    1816{{{
    19  [[BurndownChart([<query>,]<startdate>[,<enddate>][,<weekends>][,<title>][,<expected>][,<gridlines>]
     17[[BurndownChart([<query>,]<startdate>[,<enddate>][,<weekends>][,<title>][,<expected>][,<gridlines>]
    2018      [,<width>][,<height>][,<color>][,<colorexpected>][,<bgcolor>][,<wecolor>])]]
    2119}}}
    … …  
    4038|| `wecolor`|| || chart drawing area background color for weekends `[RRGGBB]` ||`cccccc` || `wecolor=10bb20` ||
    4139 Note ^1^:: The arguments can be given in any order.
    42  Note ^2^:: `[RRGGBB]` it's a 6-letter string of hexadecimal values
     40 Note ^2^:: `[RRGGBB]` is a 6-character string of hexadecimal values
    4341
    4442 '''Examples:''' ::
    … …  
    4947}}}
    5048 '''Results:''' ::
    51 {{{
    52 #!comment
    53 Below follows the almost equivalent code for above example:
    54 }}}
    55 {{{
    56 #!html
     49{{{#!comment
     50Below follows the almost equivalent code for the above example:
     51}}}
     52
     53{{{#!html
    5754<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' />
    5855}}}
    … …  
    6764 [[HoursRemaining([<query>])]]
    6865}}}   
    69  Note ^3^:: argument it's not mandatory, if not given defaults to (T.B.D.)???
     66 Note ^3^:: argument is not mandatory, if not given, then it defaults to (T.B.D.)?
    7067
    7168 '''Example:''' :: {{{Remaining effort to conclude this milestone: '''[[HoursRemaining(milestone=Sprint 1)]]''' hs.}}}
    … …  
    9289|| `color`|| || pie chart starting set of color `[RRGGBB]` ||`ff9900` ,,(a nice orange),, ||  `color=00ff00` ||
    9390 Note ^1^:: The arguments can be given in any order.
    94  Note ^2^:: `[RRGGBB]` it's a 6-letter string of hexadecimal values
     91 Note ^2^:: `[RRGGBB]` is a 6-character string of hexadecimal values
    9592 
    9693 '''Example:''' ::
    … …  
    117114  ...                                      # normal SELECT statement
    118115  id AS ticket,
    119   COALESCE(tc.value,'') as estimatedhours, # adds the value of estimatedhours in a column that must have same name original field
     116  COALESCE(tc.value,'') AS estimatedhours, # adds the value of estimatedhours in a column that must have same name original field
    120117  FROM ticket t
    121118  LEFT JOIN ...                            # other LEFT JOIN statements (in the default Trac queries) can be left in place
    122   LEFT JOIN ticket_custom tc ON tc.ticket = t.id and tc.name = 'estimatedhours'
     119  LEFT JOIN ticket_custom tc ON tc.ticket = t.id AND tc.name = 'estimatedhours'
    123120  ...
    124         }}}
     121}}}
     122
    125123  * You could change {{{''}}} to '0' to show 0 hours for tickets that don't have a corresponding estimated hours field.
    126124  * Tickets may have an estimated hours field that is empty, in which case you may still see "blank".
    … …  
    129127Using EstimationToolsPlugin you can schedule tickets of a project with SchedulingToolsPlugin.
    130128
     129== Bugs/Feature Requests
     130
     131Existing bugs and feature requests for EstimationToolsPlugin are
     132[report:9?COMPONENT=EstimationToolsPlugin here].
     133
     134If you have any issues, create a
     135[/newticket?component=EstimationToolsPlugin new ticket].
     136
     137[[TicketQuery(component=EstimationToolsPlugin,group=type,format=progress)]]
     138
     139== Download
     140
     141Download the zipped source from [download:estimationtoolsplugin here].
     142
     143There is also an
     144[http://dl.dropbox.com/u/4213259/deb/trac-estimationtools_0.4.5-1_all.deb unofficial Debian package]
     145(source: [http://dl.dropbox.com/u/4213259/deb/trac-estimationtools_0.4.5.orig.tar.gz orig.tar.gz]
     146[http://dl.dropbox.com/u/4213259/deb/trac-estimationtools_0.4.5-1.debian.tar.gz debian.tar.gz]
     147[http://dl.dropbox.com/u/4213259/deb/trac-estimationtools_0.4.5-1.dsc dsc]).
     148
     149== Source
     150
     151You can check out EstimationToolsPlugin from [http://trac-hacks.org/svn/estimationtoolsplugin here] using Subversion, or [source:estimationtoolsplugin browse the source] with Trac.
     152
    131153== Installation
    132154
    … …  
    134156  * Trac 0.11.x and Trac 0.12.x is supported in [http://trac-hacks.org/svn/estimationtoolsplugin/trunk trunk].
    135157  * The latest version for Trac 0.10 can be checked out [http://trac-hacks.org/svn/estimationtoolsplugin/branches/0.10 here].
    136    1. Manually: Deploy the egg:
     158   1. Manually: deploy the egg:
    137159  {{{#!sh
    138160python setup.py bdist_egg
    … …  
    152174 1. '''Enable''' the plugin in the `trac.ini` file:
    153175 {{{#!ini
    154  [components]
    155  estimationtools.* = enabled
     176[components]
     177estimationtools.* = enabled
    156178}}}
    157179 1. '''Configure''' the plugin at its own configuration section in the `trac.ini` file:
    … …  
    181203=== Plugin Installation
    182204
    183 Still in doubt? Please see [http://trac.edgewall.org/wiki/TracPlugins Trac's plug-in installation instructions] for more details.
    184 
    185 == Bugs/Feature Requests
    186 
    187 Existing bugs and feature requests for EstimationToolsPlugin are
    188 [report:9?COMPONENT=EstimationToolsPlugin here].
    189 
    190 If you have any issues, create a
    191 [http://trac-hacks.org/newticket?component=EstimationToolsPlugin&owner=hoessler new ticket].
    192 
    193 [[TicketQuery(component=EstimationToolsPlugin,group=type,format=progress)]]
    194 
    195 == Source & Download
    196 
    197 You can check out EstimationToolsPlugin from [http://trac-hacks.org/svn/estimationtoolsplugin here] using Subversion, or [source:estimationtoolsplugin browse the source] with Trac.
    198 
    199 Download the zipped source from [download:estimationtoolsplugin here].
    200 
    201 There is also an
    202 [http://dl.dropbox.com/u/4213259/deb/trac-estimationtools_0.4.5-1_all.deb unofficial Debian package]
    203 (source: [http://dl.dropbox.com/u/4213259/deb/trac-estimationtools_0.4.5.orig.tar.gz orig.tar.gz]
    204 [http://dl.dropbox.com/u/4213259/deb/trac-estimationtools_0.4.5-1.debian.tar.gz debian.tar.gz]
    205 [http://dl.dropbox.com/u/4213259/deb/trac-estimationtools_0.4.5-1.dsc dsc]).
     205Please see [http://trac.edgewall.org/wiki/TracPlugins Trac's plug-in installation instructions] for more details.
    206206
    207207=== Recent Changes