Project

General

Profile

PluginCollapse » History » Version 3

Mischa The Evil, 2009-01-09 02:34
Added Todo-section based on private roadmap for version 0.0.2.

1 1 Mischa The Evil
h1. Redmine Collapse plugin
2
3
Redmine Collapse is a plugin which transforms the default Redmine sidebar into a collapsible sidebar with additional tabs.
4
5
h2. Features
6
7
* Replaces the Redmine core's sidebar
8
** The provided sidebar is collapsible using JavaScript-helpers
9
** The default sidebar-content is available on the default Actions-tab
10
** An optional Projects-tab provides (nested) project-links of projects for which the current user has a role;
11
*** on Redmine 0.8.0 project-links are pointing to project overviews
12
*** on Redmine 0.8.1 project-links are pointing to the currently-watched views in the selected project (if available)
13
* Optionally, the core's project-selector drop-down menu can be hidden
14
* All the used strings can be centrally translated to every language (currently only English and Dutch are translated, for others stubs are provided)
15
16
h2. Compatibility
17
18
This plugin requires at least Redmine 0.8.0 and is compatible with the Redmine 0.8-Stable branch.
19
20
|_. Redmine version|_. Compatible?|
21
|@trunk@|Yes|
22
|@0.8.x@|Yes|
23
|@0.7.x@|No|
24
25
h2. Installation
26
27
1. Obtain the plugin by downloading the latest archive file attached to this page or from the upcoming website http://www.evil-dev.net.
28
2. Install the plugin as described "here":http://www.redmine.org/wiki/redmine/Plugins. _This plugin doesn't require migration_.
29
3. Login to your Redmine
30
31
h2. Configuration
32
33
This plugin can be configured under Administration -> Plugins -> Redmine Collapse plugin -> Configure. It provides the following implemented settings:
34
* Show the projects tab (default: yes)
35
* Hide the core project selector (default: no)
36
37
h2. Upgrade
38
39
1. Download the latest archive file attached to this page or from the upcoming website http://www.evil-dev.net.
40
2. Unzip the file to your Redmine into the vendor/plugins directory
41
3. Restart your Redmine
42
43
h2. Uninstall
44
45
1. Remove the directory @redmine_collapse@ from the plugin-directory _../vendor/plugins_.
46
2. Restart Redmine.
47
48
Make sure that no plugin-assets remain available in _../public/plugin_assets/redmine_collapse_.
49
50 3 Mischa The Evil
h2. Todo
51
52
Note that these can be a subject of change:
53
* Make the position of the collapsible sidebar configurable (left and right)
54
* Add a new tab which could provide a neat location for global-report links
55
56 1 Mischa The Evil
h2. Credits
57
58
Thanks goes out to the following people:
59
60
* Eric Davis, Little Stream Software (http://www.littlestreamsoftware.com)
61
** Provided skeleton for Redmine core patches (see _lib/collapse_application_helper_patch.rb_)
62
* Sebastian Kurfürst, Typo3 Development Team (http://www.typo3.org)
63
** Author of the Redmine core hacks, to implement this feature for Typo3-Forge, used as a base for this plugin
64
* Lalit Patel, (http://www.lalit.org)
65
** Provided Javascript code to store data as JSON-strings in cookies (initially used by Sebastian)
66
67
h2. License
68
69
This plugin is licensed under the GNU GPL v2. See LICENSE.txt and GPL.txt for details.
70
71
h2. Project help
72
73 2 Mischa The Evil
If you need help, would like to report a bug or would like to request a new feature you can contact the maintainer at his upcoming "website":http://www.evil-dev.net. Or, join the @#redmine@-channel on the "freenode":http://freenode.net/irc_servers.shtml IRC network and see if the maintainer is connected (with the nickname @Mischa_The_Evil@).