Changes between Version 27 and Version 28 of SumStatsPlugin


Ignore:
Timestamp:
Nov 19, 2015, 11:15:41 AM (8 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • SumStatsPlugin

    v27 v28  
    2727== Download
    2828
    29 Download the zipped source from [download:sumstatsplugin here].
     29Download the zipped source from [export:sumstatsplugin here].
    3030
    3131== Source
    3232
    33 You can check out SumStatsPlugin from [http://trac-hacks.org/svn/sumstatsplugin here] using Subversion, or [source:sumstatsplugin browse the source] with Trac.
     33You can check out SumStatsPlugin from [/svn/sumstatsplugin here] using Subversion, or [source:sumstatsplugin browse the source] with Trac.
    3434
    3535== Installation and Configuration
    … …  
    3737 1. Install the plugin, after downloading and unzipping:
    3838    {{{#!sh
    39     cd sumstatsplugin/0.12
    40     sudo python setup.py install
    41     }}}
     39cd sumstatsplugin/0.12
     40sudo python setup.py install
     41}}}
    4242
    4343 See [http://trac.edgewall.org/wiki/TracPlugins TracPlugins] for more installation details and options. You will likely need to restart Trac's web server after installation.
    … …  
    4545 2. Enable the plugin in your `trac.ini` file:
    4646    {{{#!ini
    47     [components]
    48     sumstats.* = enabled
    49     }}}
     47[components]
     48sumstats.* = enabled
     49}}}
    5050
    5151 You can alternatively use the Trac Web Admin GUI.
    … …  
    5353 3. Replace the {{{DefaultTicketGroupStatsProvider}}} with this plugin's new {{{SumTicketGroupStatsProvider}}} in `trac.ini`:
    5454    {{{#!ini
    55     [roadmap]
    56     stats_provider = SumTicketGroupStatsProvider
    57    
    58     [milestone]
    59     stats_provider = SumTicketGroupStatsProvider
    60     }}}
     55[roadmap]
     56stats_provider = SumTicketGroupStatsProvider
    6157
    62  4. (Optional) Configure the main {{{sumstats}}} section in `trac.ini`::
     58[milestone]
     59stats_provider = SumTicketGroupStatsProvider
     60}}}
     61
     62 4. (Optional) Configure the main {{{sumstats}}} section in `trac.ini`:
    6363    {{{#!ini
    64     [sumstats]
    65     field = effort
    66     label = effort
    67     drilldown_label = Ticket effort
    68     filter = type!=epic
    69     query_args = col=summary,col=type,col=effort
    70     }}}
     64[sumstats]
     65field = effort
     66label = effort
     67drilldown_label = Ticket effort
     68filter = type!=epic
     69query_args = col=summary,col=type,col=effort
     70}}}
    7171
    7272 The optional {{{field}}} option specifies which field to sum. The optional {{{drilldown_label}}} and {{{label}}} options are used to define the {{{TicketGroupStats}}} object. The optional {{{filter}}} is a list of additional global filters for all groups (if specified it's currently limited to standard fields only). 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.
    … …  
    108108}}}
    109109
    110 This 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.
     110This 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 supported, although there are currently no checks for duplicate "catch all" or otherwise redundant group definitions.
    111111
    112112=== Burndown chart data source
    … …  
    126126`http://<your-trac-domain>/sumstats/query`
    127127
    128 The above request returns a data table (in JSON response format) of up to four columns:
     128The above request returns a data table (in JSON response format) of up to 4 columns:
    129129
    130130 * {{{day}}} - the day