Redmine plugins

1. General Plugin Instructions

• download a plugin from plugin list,
• copy plugin directory into #{RAILS_ROOT}/vendor/plugins.
• if the plugin requires a migration, run the following command to upgrade your database (make a db backup before)

rake db:migrate_plugins RAILS_ENV=production

• Restart Redmine
• see the plugin list in "Administration -> Plugins" and configure the newly installed plugin

2. Plugins

2.1. Global Filter

GlobalFilter (download, mirror) displays a list of "global" filters on your Redmine homepage, for easy access to issues that satisfy the filters across your projects. Note that searches made via this plugin only span projects where you are a member.
Install into global_filter_redmine_plugin.

2.2. Charts

Charts (download, mirror) integrates some project-based, time-tracking charts

Depends on OpenFlashChart (download, mirror).

Installation: install OpenFlashChart into vendor/plugins/open_flash_chart, copy assets/open-flash-chart.swf into RAILS_ROOT/public, copy assets/javascript/swfobject.js into RAILS_ROOT/public/javascripts. Install Charts plugin into vendor/plugins/redmine_charts.

Note: open flash chart raises syntax error in /open_flash_chart/lib/open_flash_chart/candle.rb:13, so please correct this line

def initialize( high, open, close, low, args={} )

Restart Redmine. In the preferred Redmine project, go to the "Project settings". On the "Modules" tab: enable the plugin-module by checking "Charts". A new item named "Charts" will show up in the project menu.

2.3. Embedded

Embedded lets you embed HTML files (eg. documentation, test reports...) in projects
Install plugin tarball from mirror or checkout from source repository

 cd /var/www/redmine
 ruby script/plugin install http://redmine.rubyforge.org/svn/plugins/embedded

Restart redmine. Go to Administration > Plugins > Embedded > Configure and set per-project HTML directory. Enable module in chosen projects.

2.4. Questions

Questions (download, mirror) plugin improves the workflow of Redmine by allowing users to ask questions directly to other users in issue notes. To ask a question, just update an issue and select a Member from the question select box right below the issue notes.
Features:

• Question can be assigned to be answered by a project member.
• Questions are highlighted so they can be found easily and prevent communications from failing.
• Filters for the issue list: "Question is assigned to", "Question was asked by". Question column for the Issue list showing a preview of all the open questions asked on an issue
• Email notification when questions are asked and answered

Installation: install plugin into questions_plugin, run plugin migration to create questions tables

rake db:migrate_plugins RAILS_ENV=production

and restart redmine.

2.5. TODO

TODO lists plugin (download, mirror) allows you to create nestable per-project todo lists, as well as a general, personal ToDo list for stuff not related to a particular project.
Install into vendor/plugins/redmine_todos_plugin, run migration (rake db:migrate_plugins RAILS_ENV=production) and restart Redmine. Enable plugin module in a chosen project and go to the ToDos tab.
Database migration is broken in this plugin. After installation, disable plugin migration scripts (not needed in versions 0.4+ on redmine 0.9.x)

 cd /var/www/redmine/vendor/plugins/redmine_todos_plugin/db
 mv migrate migrate.disabled

2.6. Graphs

Graphs (download fork for 0.8.5, mirror, download for trunk) plugin provides additional graphs for the system: version completion (total issues vs closed issues over time in a single version), open aging issues (by creation date and last updated date), total issues over time (all issues over time)
Install into vendor/plugins/redmine_graphs.

Note: The latest version as of 23.03.2010 has a minor i18n bug resulting in greek menu. To fix, edit redmine_graphs/config/locales/el.yml and replace "en:" with "el:".

2.7. Budget

Budget

is a plugin to manage the set of deliverables for each project, automatically calculating key performance indicators.

Installation: install holidays gem as per plugin's readme:

gem install holidays

Download plugin from github repository and install under vendor/plugins/budget_plugin. Run database migration:

RAILS_ENV=production rake db:migrate_plugins

Restart web server. Surf to the redmine/settings/plugin/budget_plugin configuration page and setup maximum budget overhead. Enable the budget module in your projects.

2.8. Schedules

Schedules plugin allows to manage users and assigned projects over time. The primary problems that it addresses (and aims to address) are questions like the following: If I'm assigned to many projects, which ones should I work on today? How many developer hours are committed to my project this Tuesday? I need another developer for my project tomorrow, who's available? Are my project's developers logging their time appropriately?

Installation:

• download rates plugin tarball from the project page and install under vendor/plugins/redmine_rate.
• download schedules plugin tarball from the github repository and install under vendor/plugins/redmine_schedules.
• migrate database using RAILS_ENV=production rake db:migrate_plugins
• restart web server

2.9. Timesheet

Timesheet plugin allows to show and filter timelogs across all projects in Redmine.

2.10. Bug cloud

BugCloud visualizes the issues of a project as an issue cloud.

3. Rejected Plugins

3.1. Screenshot paste

Screenshot paste plugin allows pasting a screenshot from the clipboard on the issue form. This module breaks the issue form at the moment.

3.2. Google Calendar

This plugin is alpha-quality code. It causes iframe code trash the project overview tab, and the patch make the project fail. The installation procedure is too cumbersome.

GoogleCalendar (download, mirror) provides the project-manager a way to include a Google Calendar iframe as a tab within Redmine projects.
The plugin requires the tzinfo gem to be available:

gem install tzinfo

Download and install the plugin.

Install the Redmine 0.8.5 patch (see issue #1746) which provides an option to hide project custom fields from the project overview, or you'll see the iframe code on the project overview tab. This patch can cause affected project to fail.

Restart Redmine.

Go to "Administration -> Custom fields" and create a Project custom field of the type "long text", named "Google Calendar iFrame". Go to "Administration -> Plugins -> Google Calendar Plugin > Configure" to configure the Google Calendar plugin. Select the just created project custom field "Google Calendar iFrame".

Retrieve the actual Google Calendar embedding-code (<iframe>). Go to the Google Calendar which you want to embed, click on "Settings" in the upper left hand corner, click on the "Calendars" tab, select the calendar you want to use, in the "Embed This Calendar" section, copy the entire <iframe> code from the text box. If this is a private calendar, you will have to replace the "src" in the <iframe> with the HTML found by clicking the blue "HTML" block in the "Private Address" section on the same page (see detailed help here).

In the preferred Redmine project, go to the "Project settings". On the "Modules" tab: enable the plugin-module by checking "Google Calendar". On the "Information" tab: paste the <iframe> code, that you have copied to your clipboard from the Google Calendar you want to embed, into the 'Google Calendar iFrame' project custom field you created in the global setup under step 1.

Finally, a new item "Calendar" will show up in the project menu. Click on this item to see your Google Calendar.

3.3. Stuff To Do

When issues are dragged, the plugin periodically fails with "Error saving the lists. Please refresh page and try again" (issue 2113 is not yet fixed).

Stuff To Do (download, mirror) plugin allows a user to order and prioritize the issues they are doing into a specific order. It will also allow other privileged users to reorder the user's workload.

Install plugin to vendor/plugins/stuff_to_do_plugin. Run plugin migrations (rake db:migrate_plugins RAILS_ENV=production). Restart redmine. Login and click the Stuff To Do link in the top left menu.

There are three panes that can be sorted:

• What I'm doing now. This pane lists the next 5 issues a user is supposed to be working on. These issues should be the most important issues assigned to the user. As the user closes an issue, the items lower in the list will rise up and fill in this pane.
• What's recommended to do next. This pane lists up to 10 extra tasks for the user. These tasks are used as overflow for the What I'm doing now.
• What's available. This pane lists all the open issues that are assigned to the user. They are the pool of issues that a user can draw on as they work on issues.

The standard workflow for this plugin is as follows:

• A user will drag issues from the What's Available pane to the What I'm doing now and What's recommended to do next
• Once 15 issues have been dragged (5 Now, 10 Next) the user would prioritize and sort the issues in order of importance
• The user would use the rest of Redmine and work on the #1 issue
• Once the #1 issue is complete (or blocked) the user would continue and work on the #2 issue

If the user is an Administrator, they have the permission to edit other users' lists. This allows them to act as the system Project Manager.

Вложения

redmine-0.8.5-add_project-custom-field_hide.patch

redmine-0.8.5-add_project-custom-field_hide.patch 3.21 КБ