PluginCharts » History » Version 3

Dominic Clifton, 2010-05-14 11:48

1 1 Mischa The Evil
h1. Charts plugin
2 1 Mischa The Evil
3 1 Mischa The Evil
{{>toc}}
4 1 Mischa The Evil
5 1 Mischa The Evil
A Redmine plugin which integrates some project-based, time-tracking charts.
6 1 Mischa The Evil
7 1 Mischa The Evil
h2. Author
8 1 Mischa The Evil
9 1 Mischa The Evil
* Maciej Szczytowski
10 1 Mischa The Evil
11 1 Mischa The Evil
h2. Changelog
12 1 Mischa The Evil
13 1 Mischa The Evil
h3. 0.0.12
14 1 Mischa The Evil
15 1 Mischa The Evil
* many bug fixes ("!#6":http://github.com/mszczytowski/redmine_charts/issues/#issue/6, "!#7":http://github.com/mszczytowski/redmine_charts/issues/#issue/7, "!#8":http://github.com/mszczytowski/redmine_charts/issues/#issue/8, "!#9":http://github.com/mszczytowski/redmine_charts/issues/#issue/9, "!#10":http://github.com/mszczytowski/redmine_charts/issues/#issue/10)
16 1 Mischa The Evil
* new conditions (trackers, priorities, versions)
17 1 Mischa The Evil
* pages on deviations chart ("!#5":http://github.com/mszczytowski/redmine_charts/issues/#issue/5)
18 1 Mischa The Evil
* hours logged for project and not estimated issues on deviations chart
19 1 Mischa The Evil
20 1 Mischa The Evil
h2. Latest release
21 1 Mischa The Evil
22 1 Mischa The Evil
The currently available, latest release of the plugin is version *0.0.12*.
23 1 Mischa The Evil
24 1 Mischa The Evil
h2. Description
25 1 Mischa The Evil
26 1 Mischa The Evil
The Charts plugin integrates some project-based, time-tracking charts. Most of the charts provided by this plugin depend on issues which have a certain amount of estimated time set and logged spent-time (on plugins as well as on the project itself).
27 1 Mischa The Evil
28 1 Mischa The Evil
h3. Chart types
29 1 Mischa The Evil
30 1 Mischa The Evil
In total four kinds of charts are provided by the plugin:
31 1 Mischa The Evil
# @Burndown@
32 1 Mischa The Evil
** Timeline with estimated, logged and remaining hours.
33 1 Mischa The Evil
# @Logged hours ratio@
34 1 Mischa The Evil
** Number of hours which were logged, proportional to total total, grouped and filtered by users, issues, activities, categories, version, priorities or trackers.
35 1 Mischa The Evil
# @Logged hours timeline@
36 1 Mischa The Evil
** Timeline with logged hours, grouped and filtered by users, issues, activities, categories, version, priorities and trackers.
37 1 Mischa The Evil
# @Logged hours deviations@
38 1 Mischa The Evil
** Ratio of logged and remaining hours to estimated hours for each estimated issue.
39 1 Mischa The Evil
40 1 Mischa The Evil
h2. Screenshots
41 1 Mischa The Evil
42 1 Mischa The Evil
h3. Burndown chart
43 1 Mischa The Evil
44 1 Mischa The Evil
!http://farm4.static.flickr.com/3487/3219872709_03a137e740_o.jpg!
45 1 Mischa The Evil
46 1 Mischa The Evil
h3. Logged hours ratio chart
47 1 Mischa The Evil
48 1 Mischa The Evil
!http://farm4.static.flickr.com/3313/3220723922_64540005a0_o.jpg!
49 1 Mischa The Evil
50 1 Mischa The Evil
h3. Logged hours timeline
51 1 Mischa The Evil
52 1 Mischa The Evil
!http://farm4.static.flickr.com/3112/3220723804_2b274e7e2f_o.jpg!
53 1 Mischa The Evil
54 1 Mischa The Evil
h3. Logged hours deviations
55 1 Mischa The Evil
56 1 Mischa The Evil
!http://farm4.static.flickr.com/3441/3219872389_4f1d105c1d_o.jpg!
57 1 Mischa The Evil
58 1 Mischa The Evil
h2. Compatibility
59 1 Mischa The Evil
60 1 Mischa The Evil
This plugin is compatible with Redmine 0.8.x as well as with the current Redmine trunk.
61 1 Mischa The Evil
62 1 Mischa The Evil
h2. Dependencies
63 1 Mischa The Evil
64 1 Mischa The Evil
This plugin relies on the "OpenFlashChart":http://pullmonkey.com/projects/open_flash_chart Rails plugin to render the charts. It can be installed into your Redmine instance using the following commands:
65 1 Mischa The Evil
<pre>
66 1 Mischa The Evil
$ cd {REDMINE_ROOT}
67 1 Mischa The Evil
$ ./script/plugin install git://github.com/pullmonkey/open_flash_chart.git
68 1 Mischa The Evil
</pre>
69 2 Chris McKee
In Windows
70 2 Chris McKee
<pre>
71 2 Chris McKee
cd {REDMINE_ROOT}
72 2 Chris McKee
ruby script\plugin install http://github.com/pullmonkey/open_flash_chart.git
73 2 Chris McKee
</pre>
74 1 Mischa The Evil
75 1 Mischa The Evil
h2. Obtaining 
76 1 Mischa The Evil
77 1 Mischa The Evil
bq. URL of the GitHub repository: http://github.com/mszczytowski/redmine_charts/tree/
78 1 Mischa The Evil
79 1 Mischa The Evil
The source of this plugin can be "cloned" from the GitHub-repo using:
80 1 Mischa The Evil
<pre>
81 1 Mischa The Evil
$ cd {RAILS_ROOT}
82 1 Mischa The Evil
$ git clone git://github.com/mszczytowski/redmine_charts.git vendor/plugins/redmine_charts
83 1 Mischa The Evil
</pre>
84 1 Mischa The Evil
85 1 Mischa The Evil
h2. Installation
86 1 Mischa The Evil
87 1 Mischa The Evil
# Download the plugin from the available source (see "[[PluginCharts#Obtaining|obtaining]]")
88 3 Dominic Clifton
# Install the plugin as described at: http://www.redmine.org/wiki/redmine/Plugins (this plugin contains database migrations)
89 1 Mischa The Evil
# Restart Redmine
90 1 Mischa The Evil
91 1 Mischa The Evil
h2. Setup
92 1 Mischa The Evil
93 1 Mischa The Evil
After you have completed the installation of the plugin you can select which projects will actually be able to use the feature brought by the plugin by activating the plugin's module in the "project settings":
94 1 Mischa The Evil
95 1 Mischa The Evil
In the preferred Redmine project, go to the "Project settings":
96 1 Mischa The Evil
97 1 Mischa The Evil
* On the "Modules" tab: enable the plugin-module by checking "Charts".
98 1 Mischa The Evil
99 1 Mischa The Evil
After that, a new item named "Charts" will show up in the project menu. Click on this item to see the project's charts.
100 1 Mischa The Evil
101 1 Mischa The Evil
h2. Upgrading
102 1 Mischa The Evil
103 1 Mischa The Evil
# Backup the currently deployed Charts plugin (@cp -r /vendor/plugins/redmine_charts /vendor/plugins/redmine_charts-backup@)
104 1 Mischa The Evil
# Reinstall the updated plugin:
105 1 Mischa The Evil
** using the command: @git pull@
106 1 Mischa The Evil
# Restart your Redmine
107 1 Mischa The Evil
108 1 Mischa The Evil
h2. Uninstalling
109 1 Mischa The Evil
110 1 Mischa The Evil
# Remove the directory _"redmine_charts"_ from the plugin-directory _"../vendor/plugins"_
111 1 Mischa The Evil
# Restart Redmine
112 1 Mischa The Evil
113 1 Mischa The Evil
h2. Licensing
114 1 Mischa The Evil
115 1 Mischa The Evil
This plugin is open-source and licensed under the "GNU General Public License v2":http://www.gnu.org/licenses/old-licenses/gpl-2.0.html (GPL).
116 1 Mischa The Evil
117 1 Mischa The Evil
* ©2009, Maciej Szczytowski (http://github.com/mszczytowski/)
118 1 Mischa The Evil
119 1 Mischa The Evil
h2. Support
120 1 Mischa The Evil
121 1 Mischa The Evil
If you would like to report a bug or request a new feature you can open a new issue at the issue-tracking section of the plugins' GitHub site: http://github.com/mszczytowski/redmine_charts/issues.
122 1 Mischa The Evil
You can also post about the plugin in the dedicated plugin-section of the "Redmine forums":http://www.redmine.org/projects/redmine/boards/3.
123 1 Mischa The Evil
124 1 Mischa The Evil
As an alternative you can also join the @#redmine@ channel on the "freenode":http://freenode.net/irc_servers.shtml IRC network to see if there is anyone who can provide some support.