[[PageOutline(2-5,Contents,pullout)]]

= Render burndown images in svg format

'''Links:'''
[query:status!=closed&component=TimeVisualizerPlugin&order=priority open tickets]
| [/newticket?component=TimeVisualizerPlugin new ticket]
| [/svn/timevisualizerplugin svn]
| [browser:timevisualizerplugin browse code]

== Description

This plugin creates customizable burndown graphs from the ticket history provided by TimingAndEstimationPlugin. Dynamic graphs can be easily embedded into Trac wiki pages.

Developed and tested with Trac 0.10.4, Python 2.4, sqlite, mod_python and Apache on Windows. The 0.6 version works on Trac 0.11.

== Bugs/Feature Requests

Existing bugs and feature requests for TimeVisualizerPlugin are 
[report:9?COMPONENT=TimeVisualizerPlugin here].

If you have any issues, create a 
[/newticket?component=TimeVisualizerPlugin new ticket].

[[TicketQuery(component=TimeVisualizerPlugin,group=type,format=progress)]]

== Installation

'''Dependencies:''' TimingAndEstimationPlugin was needed in 0.4 and earlier versions to feed the database with estimates and totalhours custom tickets. Browser must be able render SVG natively and support the html tag iframe. The latest Firefox, Opera and Safari browser versions should work.

 1. Get source files and install it:
 {{{#!sh
svn co https://trac-hacks.org/svn/timevisualizerplugin/branches/TimeVisualizer_0.6
cd TimeVisualizer_0.6
python setup.py install
}}}
 1. Edit your `trac.ini` file to enable the plugin:
 {{{#!ini
[components]
<...other components...>
tractimevisualizerplugin.* = enabled
}}}
 1. Restart server to propagate changes.

For details, see browser:/timevisualizerplugin/branches/TimeVisualizer_0.6/release_notes.txt

== Usage

To test graphs and filtering, access "http://server:port/path_to_trac_env/tractimevisualizer". It will render the hours from the whole project's life cycle.

More practical is to get graphs from a certain time frame and filter the hours based on milestone and/or component. This is achieved with macro !BurnDown. I wrote this plugin to replace ScrumBurndownPlugin, because its graphing capabilities were limited and it modifies the database schema.

In my example project, I have a wiki page with following content:
{{{
[[BurnDown(width=800,height=200,query=targetmilestone=mile1&datestart=08/8/07&dateend=8/22/07)]]

[[BurnDown(width=400,height=200,query=targetmilestone=mile1&datestart=08/8/07&dateend=8/15/07)]]
[[BurnDown(width=400,height=200,query=targetmilestone=mile1&datestart=08/15/07&dateend=8/22/07)]]
}}}

It renders the following graphs (picture is cropped to fit better on this page):

[[Image(TracTimeVisualizerPlugin_ss1.PNG)]]

[[Image(0.7_screenshot.png)]]

For more, see browser:/timevisualizerplugin/branches/TimeVisualizer_0.6/release_notes.txt

== Feedback

Feel free to [wiki:TimeVisualizerPlugin/FeedBack give feedback].

== Recent Changes

[[ChangeLog(timevisualizerplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:mape] (thtv08 _at_ gmail.com) [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:''' [[BR]]