Documentation - Redmine Table Calculation¶

Create spreadsheets with simple calculation capabilities for each project

Redmine Table Calculation is a plugin which lets the user create spreadsheets with simple calculation capabilities for each project.

• Table of contents
• Documentation - Redmine Table Calculation
  • Getting Started
    • Downloading the plugin
    • Plugin Dependencies
    • Restart Redmine
    • Plugin Usage
      • Create Table Columns
      • Create Table
      • Create Calculation (optional)
      • Create Spreadsheet
  • 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_table_calculation folder
into your plugin directory.

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

Plugin Dependencies¶

Redmine Table Calculation depends on

• Redmine Project Types
• Redmine Project Types Relations
• Advanced Plugin Helper

Restart Redmine¶

Navigate into your Redmine 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¶

Create Table Columns¶

Before you can create a table you need some table columns. For doing so, navigate to Administration -> Custom Fields -> Tables and create the respective fields.

Create Table¶

Navigate to Administration -> Table Configuration. Create a new table and select the columns you wish and select the project types where the table should be available.

Create Calculation (optional)¶

Navigate to Administration » Table Configuration » Calculations.

Create a new calculation. Select the columns over which you would like to calculate. The following custom field formats are supported:

• Float
• Integer
• Boolean
• Enumeration (where the position number is used for calculation)

All other formats return - as result.

Create Spreadsheet¶

Navigate to a project having one of the project types selected earlier when creating a table. Click the table menu item and create a new spreadsheet. Choose the table which should be the base for the spreadsheet.

Start to enter your data!

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 Table Calculation.

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

Licence¶

Copyright © 2020-2024 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.