PluginCollapse » History » Version 7

Mischa The Evil, 2009-01-26 00:54
Added compatibility-info after r2304 + added 2 new todo-items

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