Documents Short plugin¶

A Redmine plugin which displays the documents list in a shorter way.

Author¶

Stéphane Moreau

Latest release¶

The currently available, latest release of the plugin is version 0.6.0.

Description¶

The Documents Short plugin is a Redmine plugin which displays the documents list in a shorter way. This is done by using the JavaScript tooltip framework called Opentip (www.opentip.org/).

Screenshot¶

Compatibility¶

This plugin has been tested on Redmine 2.1.x, 2.3.x, 2.4.x, 3.0.x, 3.1.x, 3.2.x, 5.0.x and 5.1.x.

Obtaining¶

URL of the GitHub repository: https://github.com/smoreau/redmine_documents_short

The source of this plugin can be “cloned” from the GitHub-repo using:

$ cd {REDMINE_ROOT}/vendor/plugins
$ git clone git@github.com:smoreau/redmine_documents_short.git

Installation¶

1. Download the plugin from the available source (see http://www.redmine.org/plugins/redmine_documents_short#Obtaining)
2. Install the plugin as described at: www.redmine.org/projects/redmine/wiki/Plugins (this plugin does not require a plugin database migration)
3. Restart Redmine

Setup¶

Nothing to setup. This is the beauty of it!

Upgrading¶

1. Backup the currently deployed Documents Short plugin (cp -r /vendor/plugins/redmine_documents_short /vendor/plugins/redmine_documents_short-backup)
2. Reinstall the updated plugin:
   • using the command: git pull
3. Restart your Redmine

Uninstalling¶

1. Remove the directory “redmine_documents_short” from the plugin-directory “../vendor/plugins”
2. Restart Redmine

Support¶

If you would like to report a bug or request a new feature you can open a new issue at the issue-tracking section of the plugins’ GitHub site: https://github.com/smoreau/redmine_documents_short/issues.

Licensing¶

This plugin is open-source and licensed under the “GNU General Public License v2” (www.gnu.org/licenses/old-licenses/gpl-2.0.html) (GPL). See the included COPYRIGHT.txt and GPL.txt files for details.

• (C) 2024, Stéphane Moreau (www.logikdev.com)