Project

General

Profile

PluginCollapse » History » Version 8

Mischa The Evil, 2009-02-20 00:52
Added to-be-done compatibility-test reminder.

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 4 Mischa The Evil
h2. Screenshots
17
18 6 Mischa The Evil
|=. *Global view; Collapsed sidebar*  |=. *Global view; Un-collapsed sidebar, Projects-tab*  |
19
| !global_collapsed.jpg!              | !lobal_un-collapsed_projects-tab.jpg!                |
20
21
|=. *Project view; Un-collapsed sidebar, Projects-tab*  |=. *Project view; Un-collapsed sidebar, Actions-tab*  |
22
| !project_un-collapsed_projects-tab.jpg!               | !project_un-collapsed_actions-tab.jpg!               |
23
24
|=. *Settings view; Project-selector shown*   |=. *Settings view; Project-selector hidden*  |
25
| !settings_project-selector-not-hidden.jpg!  | !settings_project-selector-hidden.jpg!      |
26 4 Mischa The Evil
27 1 Mischa The Evil
h2. Compatibility
28
29
This plugin requires at least Redmine 0.8.0 and is compatible with the Redmine 0.8-Stable branch.
30
31
|_. Redmine version|_. Compatible?|
32 7 Mischa The Evil
|@trunk < r2304@|Yes|
33
|@trunk > r2304@|No|
34 8 Mischa The Evil
|@0.8.1@|Probably, but yet to be tested|
35
|@0.8.0@|Yes|
36 1 Mischa The Evil
|@0.7.x@|No|
37
38
h2. Installation
39
40
1. Obtain the plugin by downloading the latest archive file attached to this page or from the upcoming website http://www.evil-dev.net.
41 5 Mischa The Evil
2. Install the plugin as described "here":http://www.redmine.org/wiki/redmine/Plugins#Installing-a-plugin. _This plugin doesn't require migration_.
42 1 Mischa The Evil
3. Login to your Redmine
43
44
h2. Configuration
45
46
This plugin can be configured under Administration -> Plugins -> Redmine Collapse plugin -> Configure. It provides the following implemented settings:
47
* Show the projects tab (default: yes)
48
* Hide the core project selector (default: no)
49
50
h2. Upgrade
51
52
1. Download the latest archive file attached to this page or from the upcoming website http://www.evil-dev.net.
53
2. Unzip the file to your Redmine into the vendor/plugins directory
54
3. Restart your Redmine
55
56
h2. Uninstall
57
58
1. Remove the directory @redmine_collapse@ from the plugin-directory _../vendor/plugins_.
59
2. Restart Redmine.
60
61
Make sure that no plugin-assets remain available in _../public/plugin_assets/redmine_collapse_.
62
63 3 Mischa The Evil
h2. Todo
64
65
Note that these can be a subject of change:
66
* Make the position of the collapsible sidebar configurable (left and right)
67 1 Mischa The Evil
* Add a new tab which could provide a neat location for global-report links
68 7 Mischa The Evil
* Try to make the plugin upwards compatible with Redmine @trunk > r2304@ while maintaining backwards compatibility with the @0.8-stable branch@
69
* Add a new configurable tab to hold the project-menu items (thanks to Eric Davis for the idea)
70 3 Mischa The Evil
71 1 Mischa The Evil
h2. Credits
72
73
Thanks goes out to the following people:
74
75
* Eric Davis, Little Stream Software (http://www.littlestreamsoftware.com)
76
** Provided skeleton for Redmine core patches (see _lib/collapse_application_helper_patch.rb_)
77
* Sebastian Kurfürst, Typo3 Development Team (http://www.typo3.org)
78
** Author of the Redmine core hacks, to implement this feature for Typo3-Forge, used as a base for this plugin
79
* Lalit Patel, (http://www.lalit.org)
80
** Provided Javascript code to store data as JSON-strings in cookies (initially used by Sebastian)
81
82
h2. License
83
84
This plugin is licensed under the GNU GPL v2. See LICENSE.txt and GPL.txt for details.
85
86
h2. Project help
87
88 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@).