Documentation - Redmine Subproject Collapse¶

Collapse subproject list in card view

Redmine Subproject Collapse is a Redmine Plugin. It collapse all subprojects in the card view on the project overview page to get a better overview.

• Table of contents
• Documentation - Redmine Subproject Collapse
  • Getting Started
    • Downloading the plugin
    • Restart Redmine
  • Plugin Usage
  • Compatability
  • Uninstall
  • Changelog
  • Licence

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_subproject_collapse folder
into your plugin directory.

cd (REDMINE_ROOT_DIR)/plugins
git clone https://github.com/xmera-circle/redmine_subproject_collapse.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 project overview page.

Compatability¶

This plugin is tested with

• Redmine default theme
• Alternate
• Classic
• PurpleMine2

Uninstall¶

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

bundle exec rake redmine:plugins:migrate NAME=redmine_subproject_collapse 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 Subproject Collapse.

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

Licence¶

The MIT License (MIT)

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

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.