Skip to content

Latest commit

 

History

History
68 lines (42 loc) · 3.01 KB

README.md

File metadata and controls

68 lines (42 loc) · 3.01 KB
Raw

Redmine Application Space

Tested with redmine 2.3.2, 2.4.2, 2.5.1 compatible with 2.x

Enhance Redmine application menu (the one that is displayed when browsing outside of projects) with dynamic configurability options.

  • Administrators can select the set of applications available
  • Users can select the applications they will see listed in the application menu

Both full controllers and partials (e.g. the my/blocks views) can be made an application.

Installation

Follow standard Redmine procedure, including database migrations

cd {redmine root}
git clone https://github.com/maxrossello/redmine_app__space.git plugins/redmine_app__space
RAILS_ENV=production rake redmine:plugins:migrate

Usage

As an administrator, enter the plugin configuration page and flag the applications you want to enable. You can select a group of authorized users per each application.

Applications

As an user, you can find a new 'Applications' entry in the top-left menu, which allows to select applications wanted into the application menu.

Applications

Plugins that add entries into the application menu in the standard Redmine way keep a fixed, non configurable entry.

How to create a new managed app

  • name your plugin 'redmine_app_<appname>'.

    Note that this plugin is named with a double underscore between 'app' and 'space', so your plugin will be always loaded after this, which is mandatory.

  • this plugin creates two new routing verbs, 'application' for apps with a controller, and 'block' for simple partials to display as apps.

    These verbs create routes from 'apps/<name>' that must be loaded before this plugin load 'apps/:tab' in order not to be ignored.

    Therefore, you must declare your app routing within init.rb into a section like the following examples:

       RedmineApp::Application.routes.prepend do
      application 'name_of_app', :to => 'controller#method', :via => get
      block 'name_of_app', 'partial_path'
   end

    The syntax is similar to that of the 'match' verb, with some simplifications. Blocks restrict to the get method as default if :via is not specified.

    An additional option :if is added in order to add further filters to application visibility, for example, when the admin can enable the app but some further user permission is needed. The option needs a callback with one parameter (the user). Example:

      application 'name_of_app', :to => 'controller#method', :via => get, :if => lambda { |user| ..... }

  • create translations:

    • label_<name_of_app> is the applications menu entry
    • label_<name_of_app>_description is the help text displayed in the app selection pages

Compatible applications

Beyond several partials available in Redmine core, other dedicated applications are available: