wiki:ProgressMeterMacro

Version 44 (modified by Ryan J Ollos, 11 years ago) (diff)

Added page outline.

Contents

  1. Description
    1. Usage examples
    2. Configuration
    3. The status argument
  2. Download
  3. Installation
  4. Bugs/Feature Requests
  5. Recent Changes
  6. Author/Contributors

Progress meter with arguments similar to TicketQuery macro

Description

This macro plugin was created because of ​this task for GHOP/Python Software Foundation.

It contains a macro to display a progress meter similar to the meters visible in the Roadmap. In a wiki page it can be used, for example, for building a complete report of the progress on tickets owned by a particular person. The ProgressMeter macro works with the same comma-separated list of keyed parameters (named fields of a ticket) as the ​TicketQuery macro, except the argument status and format.

For more complex progress statistics and metrics, see TracMetrixPlugin.

Usage examples

Display a progress meter on all your (if you're logged in) tickets in the milestone '0.1a': 

[[ProgressMeter(owner=$USER, milestone=0.1a)]]

A progress meter on tickets associated with the wiki component: 

[[ProgressMeter(component=wiki)]]

Since [10572], it's possible to customize the used stats provider in a macro call itself using the stats_provider argument: 

[[ProgressMeter(keywords~=needinfo, stats_provider=CustomStatsProvider)]]

Configuration

The macro supports the following configuration options:

  • stats_provider (since [5224]): Name of the component implementing ITicketGroupStatsProvider, which is used to collect statistics on groups of tickets for meters generated by the ProgressMeterMacro plugin. Defaults to DefaultTicketGroupStatsProvider.

All of these must be put into the progressmeter section of trac.ini. The progress bars themselves can be modified using ​wiki:TracIni#milestone-groups-section.

The status argument

The status argument is ignored since [5224] triggers an error since [8558]. If you want to define which ticket states are considered closed have a look at ​the appropriate section of trac.ini instead.

Download

  • Subversion repo: svn checkout https://trac-hacks.org/svn/progressmetermacro
  • ​Git mirror: git clone git://github.com/andrejtokarcik/trac-progressmetermacro.git
  • [download:progressmetermacro zip archive]
  • source browser​

Installation

See ​wiki:TracPlugins#InstallingaTracPlugin for the installation instructions. Please note that Trac 0.11.5 is a minimum requirement in order for the plugin to work.

Bugs/Feature Requests

Existing bugs and feature requests for ProgressMeterMacro are here. If you have any issues, create a new ticket.

Recent Changes

14871 by rjollos on 2015-08-11 19:53:08
Don't enforce Python version in setup.py, it is problematic.
11720 by qwp0 on 2012-07-09 23:24:20
ProgressMeterMacro: Version bump.
11719 by qwp0 on 2012-07-09 23:24:15
ProgressMeterMacro: Major code revision and unification across the supported Trac versions.
(more)

Author/Contributors