Redmine

h1. Tab plugin

{{>toc}}

A Redmine plugin which adds new Redmine tabs to embed content from an iframe on a per-project and system-wide base.

h2. Author

* James Turnbull

h2. Latest release

The currently available, latest release of the plugin is version *0.4.0*. Does also work with Redmine version 2.5.

h2. Changelog

For the complete changelog see the @CHANGELOG@-file in the Tab plugin directory.

h2. Description

The Tab plugin is a Redmine plugin which provides the ability to create a new Redmine tab, to embed content from an iframe, on a per-project base. This is done by storing the iframe-snippet in a project custom field.

It also provides the ability to add a new, system-wide top menu tab. The iframe-source for that tab can be configured in the plugin settings.

Besides these two features it also allows you to modify the actual tab and link names, without changing the source of the plugin, in the plugin settings.

h2. Compatibility

This plugin is compatible with both Redmine 0.8.x and Redmine trunk.

h2. Obtaining 

bq. URL of the GitHub repository: http://github.com/jamtur01/redmine_tab/tree/master

The source of this plugin can be "cloned" from the GitHub-repo using:<pre>

$ cd {RAILS_ROOT}/plugins

$ git clone git://github.com/jamtur01/redmine_tab.git

</pre>

h2. Installation

# Download the plugin from the available source (see "[[PluginTab#Obtaining|obtaining]]")

# Install the plugin as described at: http://www.redmine.org/wiki/redmine/Plugins (this plugin does not require a plugin database migration)

# Restart Redmine

h2. Setup

h3. Project-specific tabs

This plugin creates a project-menu tab in which you can embed an iframe. You can globally configure the name of the tab in the Plugins -> Tab Plugin configuration options, under "Project Specific -> Tab Name" (default is "Tab Name").

The iframe-sources for the individual projects can be configured on a per-project base using the value of a pre-configured project custom field (configured under "Project Specific -> Tab Text" (default is "none").

# You need to go to 'Admin -> Custom fields -> Project' and create a field of the type 'Long text' to hold the iframe link.

# Select the project custom field you've created in the plugin configuration, by going to Plugins -> Tab Plugin configuration options, under "Project Specific -> Tab Text".

# Inside your project you will need to add your iframe-link as the value of the project custom field you've selected. For example to embed Google: <pre><iframe src="http://www.google.com/" style="border: 0" width="800" height="600" frameborder="0" scrolling="no"></iframe></pre>

# Then use the project's Modules tab to enable the Tab module for the project; go to the preferred Redmine project -> "Project settings":

** On the "Modules" tab: enable the plugin-module by checking "Tab".

After that, the new project menu item will show up in the project menu.

h3. System-wide tab (link)

The plugin also provides the ability to add a new, system-wide top-menu tab (link). You can globally configure the name of the tab in the Plugins -> Tab Plugin configuration options, under "System wide -> Tab Name" (default is "System Tab Name").

The iframe-source for the new top menu link can be globally configured using the value of the plugin setting "System wide -> Tab Text" (default is "none").

h2. Upgrading

# Backup the currently deployed Tab plugin (@cp -r /plugins/redmine_tab /plugins/redmine_tab-backup@)

# Reinstall the updated plugin:

** using the command: @git pull@

# Restart your Redmine

h2. Uninstalling

# Remove the directory _"redmine_tab"_ from the plugin-directory _"../plugins"_

# Restart Redmine

h2. Support

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/jamtur01/redmine_tab/issues.

You can also post about the plugin in the dedicated plugin-section of the "Redmine forums":http://www.redmine.org/projects/redmine/boards/3.

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.

h2. Credits

* Mischa the Evil for extensive updates and refactoring

* Eric Davis for numerous fixes and new features

h2. Licensing

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). See the included @COPYRIGHT.txt@ and @GPL.txt@ files for details.

* ©2009, James Turnbull (http://www.james-turnbull.net)