Changes between Version 1 and Version 2 of SumStatsPlugin
- Timestamp:
- Nov 22, 2011, 9:35:40 PM (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
SumStatsPlugin
v1 v2 7 7 This is a complement to the [wiki:SumFieldsPlugin Sum Fields plugin] which sums fields in a query or report. This plugin sums fields for the Roadmap and Milestone views. These plugins are useful when assessing progress based on "points" or "ideal days" of effort instead of ticket count. 8 8 9 This plugin was inspired by the CustomRoadmapPlugin but overcomes its limitation of requiring a patch. Additionally, this plugin allows for any fields to be used to define a group, not just the default {{{status}}} field. 9 [[Image(sumstats.png)]] 10 11 This plugin was inspired by the CustomRoadmapPlugin but overcomes its limitation of requiring a patch. Additionally, this plugin allows for any fields to be used to define a group, not just the default {{{status}}} field. Lastly, I designed the plugin to be backwards compatible with the default ticket count behavior so that you can take leverage as much or little of its enhancements as desired. 12 13 == Configuration == 14 1. Install the plugin (after downloading and unzipping): 15 {{{ 16 cd sumstatsplugin/0.12 17 sudo python setup.py install 18 }}} 19 20 See [http://trac.edgewall.org/wiki/TracPlugins TracPlugins] for more installation details and options. You'll likely need to restart Trac's web server after installation. 21 22 2. Enable the plugin in {{{trac.ini}}}: 23 {{{ 24 [components] 25 sumstats.* = enabled 26 }}} 27 28 You can alternatively use the Trac Web Admin GUI. 29 30 3. Replace the {{{DefaultTicketGroupStatsProvider}}} with this plugin's new {{{SumTicketGroupStatsProvider}}} as shown here: 31 {{{ 32 [roadmap] 33 stats_provider = SumTicketGroupStatsProvider 34 35 [milestone] 36 stats_provider = SumTicketGroupStatsProvider 37 }}} 38 39 3. (Optional) Configure the main {{{trac.ini}}} section: 40 {{{ 41 [sumstats] 42 field = effort 43 label = effort 44 drilldown_label = Ticket effort 45 query_args = col=summary,col=type,col=effort 46 }}} 47 48 The optional {{{field}}} option specifies which field to sum. The optional {{{drilldown_label}}} and {{{label}}} are used to define the {{{TicketGroupStats}}} object. The optional {{{query_args}}} is a convenient, comma-delimited list that gets appended to each group's {{{query_args}}}. See the examples below for more details. 10 49 11 50 == Bugs/Feature Requests == … … 27 66 == Example == 28 67 29 Here's an example {{{trac.ini}}} config that combines a custom {{{phase}}} field with the default {{{status}}} workflow:68 Here's an example {{{trac.ini}}} config that combines a custom {{{phase}}} field with a built-in {{{resolution}}} field: 30 69 {{{ 31 [roadmap]32 stats_provider = SumTicketGroupStatsProvider33 34 [milestone]35 stats_provider = SumTicketGroupStatsProvider36 37 70 [milestone-groups] 38 71 closed = fixed … … 41 74 closed.order = 1 42 75 closed.overall_completion = true 76 43 77 readying = * 44 78 readying.field = phase 45 79 readying.order = 2 46 80 readying.color = YellowGreen 81 47 82 implementation = implementation 48 83 implementation.field = phase 49 84 implementation.order = 3 50 85 implementation.color = Yellow 86 51 87 waiting = waiting 52 88 waiting.field = phase 53 89 waiting.order = 4 54 90 waiting.color = White 91 55 92 scoping = sizing,definition 56 93 scoping.field = phase … … 58 95 scoping.color = Red 59 96 }}} 97 98 In general, the plugin maintains the same syntax and semantics as the {{{DefaultTicketGroupStatsProvider}}} to support backwards compatibility and ease of transition. If the {{{.field}}} option is omitted, then the {{{status}}} field is presumed. Note that a {{{.color}}} option is required for each group (except for any default {{{closed}}} or {{{new}}} group you have). The "catch all" {{{*}}} value is also still supported (although there are currently no checks for duplicate "catch all" or otherwise redundant group definitions). 60 99 61 100 == Recent Changes ==