Documentation - Redmine Colored Enumeration¶

Add color badges to issue custom field enumerations

Redmine Colored Enumeration is a plugin which lets the administrator define background colors for custom field enumerations.

• Table of contents
• Documentation - Redmine Colored Enumeration
  • • Dependencies
  • Getting Started
    • Downloading the plugin
    • Restart Redmine
  • Plugin Usage
    • Limitations
  • Uninstall
  • Changelog
  • Licence

Dependencies¶

To run the plugin you need the following dependencies installed:

• Redmine 5.0.z
• Advanced Plugin Helper 0.4.z
• Redmine Base Deface master

Getting Started¶

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

Downloading the plugin¶

Navigate into the plugins directory of your Redmine instance.

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

cd (REDMINE_ROOT_DIR)/plugins
git clone -b master https://github.com/xmera-circle/redmine_colored_enumeration.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¶

Navigate to the custom field section in admin area. Create a key/value list, mark the check box for Color support

save it and edit the possible values with its corresponding colors.

Limitations¶

• It is not possible to allow multiple values with key/value lists because it would not be clear which color should be shown.

Uninstall¶

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

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

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.