[[PageOutline(2-5,Contents,pullout)]] = Progress meter with arguments similar to !TicketQuery macro = == Description == This macro plugin was created because of [http://code.google.com/p/google-highly-open-participation-psf/issues/detail?id=256 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 [trac:wiki:TicketQuery TicketQuery macro], except the argument [#status-arg status] and {{{format}}}. For more complex progress statistics and metrics, see TracMetrixPlugin. === Usage examples === #usage 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 [trac:wiki:TracIni#milestone-groups-section]. === The {{{status}}} argument === #status-arg 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 [trac:wiki:TracIni#milestone-groups-section the appropriate section of trac.ini] instead. == Download == * Subversion repo: {{{svn checkout https://trac-hacks.org/svn/progressmetermacro}}} * [https://github.com/andrejtokarcik/trac-progressmetermacro Git mirror]: {{{git clone git://github.com/andrejtokarcik/trac-progressmetermacro.git}}} * [download:progressmetermacro zip archive] * [source:progressmetermacro source browser] == Installation == See [trac: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 [query:status!=closed&component=ProgressMeterMacro&order=priority here]. If you have any issues, create a [/newticket?component=ProgressMeterMacro&owner=qwp0 new ticket]. == Recent Changes == [[ChangeLog(progressmetermacro, 3)]] == Author/Contributors == * '''Author:''' [wiki:qwp0 Andrej Tokarčík] * '''Maintainer:''' [wiki:qwp0 Andrej Tokarčík] * '''Contributors:''' [wiki:rjollos Ryan J Ollos], Grzegorz Sobański, bof