Documentation - Redmine Matrix Field¶

Combination matrix as computable custom field with colored background

The Redmine Matrix Field plugin is a Redmine plugin. It displays computed results of combinations of two key/value custom fields and colores them as configured.

• Table of contents
• Documentation - Redmine Matrix Field
  • Getting Started
    • Dependencies
    • Downloading the plugin
    • Restart Redmine
  • Plugin Usage
  • Dependencies
  • Unistall
  • Changelog
  • Licence

Getting Started¶

This quick introduction shows you the most convenient way for trying out the plugin with your Redmine instance.

Dependencies¶

To run the plugin you need the following dependencies installed:

• Redmine 5.0.z
• Redmine Colored Enumeration 0.1.4
• Redmine Computable Custom Field 3.0.5

Downloading the plugin¶

Navigate into the plugins directory of your Redmine instance.

Download the latest development state as redmine_matrix_field folder
into your plugin directory.

cd (REDMINE_ROOT_DIR)/plugins
git clone https://github.com/xmera-circle/redmine_matrix_field.git

Restart Redmine¶

Navigate into the root directoy.

Run the restart Rake task. This will touch restart.txt in order to force Redmine's application server to restart and load
everything from scratch. This will register the new plugin.

cd (REDMINE_ROOT_DIR)
rake restart

Plugin Usage¶

Before you can create a matrix field you need two key/value fields with some reasonable values which you can map.

Then navigate to Administration » Custom Fields » Issues. Choose the format Combi Matrix and add the mapping formula as displayed in the screenshot below:

Save your new matrix field and enter some values:

Dependencies¶

Redmine Matrix Field depends on two additional plugins:

• Redmine Colored Enumeration

• Redmine Computable Custom Field

Unistall¶

In order to unistall the plugin you need to undo the migration first:

bundle exec rake redmine:plugins:migrate NAME=redmine_matrix_field VERSION=0

and delete the plugin settings last:

bundle exec rake plugins:settings:clear

Changelog¶

Every release comes along with a list of notable changes in order to make it easier to follow up on the progress of Redmine Colored Enumerations.

All those changes are documented in source:CHANGELOG.md.

Licence¶

Copyright © 2021-2023 Liane Hampe (liaham@xmera.de), xmera Solutions GmbH.

This plugin is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This plugin is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.