Abacusmine Redmine Theme

Foreword

Thank you for purchasing the Abacusmine theme. Below, you will find useful information about the plugin.

Contents

1. Installation
2. Troubleshooting
3. Settings
4. Update
5. Enhancement

1. Installation of Abacusmine on Redmine 5 and below

Follow the standard Redmine theme installation procedure:

1. Unzip the archive named abacusmine_<version>_UNZIP_FIRST.zip and upload it to your Redmine server to public/themes. No need to restart Redmine.
2. Alternatively, you can upload the archive named abacusmine_<version>_UNZIP_FIRST.zip to your Redmine server in /public/themes, then unzip it on the server and remove the ZIP file.

2. Installation of Abacusmine on Redmine 6+

Redmine 6 introduced asset pipelines and changed how themes are being installed:

1. Unzip the archive named abacusmine_<version>_UNZIP_FIRST.zip and upload it to your Redmine server to /themes.
2. Alternatively, you can upload the archive named abacusmine_<version>_UNZIP_FIRST.zip to your Redmine server to /themes, then unzip it on the server and remove the ZIP file.
3. Then run rm -rf tmp/cache, followed by bundle exec rake assets:precompile RAILS_ENV=production.
4. Then you will need to restart Redmine. Based on your hosting provider / web server, you will need to run the following commands. Puma: sudo systemctl restart redmine.yourcompany.com.service or Passenger: touch tmp/restart.txt.

3. Troubleshooting

There are generally 2 types of problems:

1. I don't see the theme in my theme list at ~/settings?tab=display

   • Solution 1: Check that your /public/themes directory has correct 755 permissions.
   • Solution 2: Verify that the Abacusmine directory in /public/themes contains the required folders (font, images, javascripts, stylesheets). If not, chances are you accidentally uploded a different folder to the server.

2. I selected Abacusmine in my theme list at ~/settings?tab=display, but I only see plain HTML without styles

   • Solution 1: Ensure correct 755 permissions for /public/themes/Abacusmine_<version>. Adjust permissions recursively for subdirectories using your FTP client or console if necessary.
   • Solution 2: Make sure you followed the installation instructions for Redmine 6.

3. I don't see the login logo image

   • Solution: Chances are we forgot to increase the version number within the theme.js file located in /public/themes/Abacusmine_<version>/javascripts/theme.js, namely line 21 which looks like this var templateFolderName = "abacusmine_3.0.4",. Please change the version number so it matches the parent folder name /public/themes/Abacusmine_<version> and accept our apologies.

4. Settings

Although Abacusmine does not have a GUI for settings, there are a few configurations in ~/javascripts/theme.js:

1. subFolder = ""; Leave it empty or specify your subfolder name, e.g., "/redmine".
2. issues = "Issues"; Translate "Issues" to your native language.
3. spentTime = 'Spent time'; Translate "Spent time" to your native language.
4. toggleDesc = 'Toggle descriptions'; Translate "Toggle descriptions" to your native language.
5. showSubProjectsAsDefault = false; Controls the project list display. Use "false" to hide sub-project tree initially, toggle with click; use "true" to always show sub-projects.
6. showLogoLogin = true; Set to "true" to display logo at login.
7. Company logo: unfortunately, with Redmine 6+ assets pipeline, it's not straightforward to replace the theme logo. For Abacusmine 3.0.6+ we recommend to use the RedmineX UX Upgrade plugin.
8. Login screen: unfortunately, with Redmine 6+ assets pipeline, it's not straightforward to replace the login image either. For Abacusmine 3.0.6+ we recommend to use the RedmineX UX Upgrade plugin.
9. Overrides: unfortunately, with Redmine 6+ assets pipeline, it's not easy to manage overrides using a separate overrides.css file. We recommend to use the RedmineX Overrides plugin.

5. Updating Abacusmine

Updating Abacusmine is the same as installing it, as each directory includes the version in its name. DOn't forget to clear cache and pre-compile assets when using Redmine 6+ (see point 2).

6. Enhancing Abacusmine

The Abacusmine theme is great on its own, but it works best with the following plugins:

1. RedmineX UX Upgrade (Paid)
2. RedmineX Inline Edit Issue List (Paid)
3. RedmineX Lightbox2 (Free)
4. RedmineX Overrides (Free)
5. RedmineX Timesheet (Paid)
6. RedmineUP Favorite Projects (Free)
7. RedmineUP Checklists (Free)

Enjoy! Abacus Themes Team
www.abacusthemes.com