You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+41-5Lines changed: 41 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,44 @@
1
1
# Redmine Projects Treeview plugin
2
-
This Redmine plugin allows you to show up your projects as a tree. Initially, only the root projects are displayed. If a
3
-
root project has sub projects, then they can be lazy loaded via mouse click. This is helpful when Redmine hosts many projects including sub projects where the fetching and rendering takes a considerable amount of time.
2
+
This [Redmine](http://redmine.org/) plugin allows you to show up your projects as a tree.
4
3
4
+
Initially, only the root projects are determined and displayed in projects overview. This can be helpful when Redmine hosts many projects including sub projects where the fetching and rendering takes a considerable amount of time.
5
+
6
+
If a root project has sub projects, then they can be lazy loaded via mouse click.
7
+
8
+
For this plugin a new REST resource `/projects/:id/children` was introduced, which determines and delivers the available children of given project in JSON format:
9
+
10
+
```json
11
+
{
12
+
"children": [
13
+
{
14
+
"id": 7,
15
+
"name": "MySubProject_01",
16
+
"identifier": "mysubproject_01",
17
+
"has_children": true
18
+
},
19
+
{
20
+
"id": 8,
21
+
"name": "MySubProject_02",
22
+
"identifier": "mysubproject_02",
23
+
"has_children": false
24
+
},
25
+
{
26
+
"id": 9,
27
+
"name": "MySubProject_03",
28
+
"identifier": "mysubproject_03",
29
+
"has_children": false
30
+
},
31
+
{
32
+
"id": 10,
33
+
"name": "MySubProject_04",
34
+
"identifier": "mysubproject_04",
35
+
"has_children": false
36
+
}
37
+
]
38
+
}
39
+
```
40
+
41
+
The response of this REST resource is used within AJAX call, to manipulate the DOM tree via jQuery.
5
42
6
43
## Screenshots
7
44
![alt text][screenshot]
@@ -13,8 +50,6 @@ The plugin is compatible with Redmine 3.2.X
13
50
## Installation and Setup
14
51
Please apply general instructions for Redmine plugins [here](http://www.redmine.org/wiki/redmine/Plugins).
15
52
16
-
These plugins must be installed first.
17
-
18
53
Following steps are required to install the plugin:
19
54
1. Clone this repository to your Redmine instance as `plugins/project_tree`:
20
55
@@ -26,6 +61,8 @@ Following steps are required to install the plugin:
26
61
## License
27
62
This plugin is licensed under the MIT license. See LICENSE for details.
28
63
64
+
## Special Thanks
65
+
Special thanks go to [Matthias](http://petermann-it.de) for his feedback and support in finding an optimal approach to load sub-projects lazy and testing support.
29
66
30
67
## Contributing
31
68
1. Fork it
@@ -34,5 +71,4 @@ Following steps are required to install the plugin:
34
71
4. Push to the branch (`git push origin my-new-feature`)
0 commit comments