Skip to content

Commit d5927ff

Browse files
committed
Adaptation of the readme and the involved authors
1 parent cb6219c commit d5927ff

File tree

3 files changed

+44
-8
lines changed

3 files changed

+44
-8
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2018 Uwe Heber
1+
Copyright (c) 2018 Uwe Heber [http://heber.it], Matthias Petermann [http://petermann-it.de]
22

33
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
44
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the

README.md

Lines changed: 41 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,44 @@
11
# 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.
43

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.
542

643
## Screenshots
744
![alt text][screenshot]
@@ -13,8 +50,6 @@ The plugin is compatible with Redmine 3.2.X
1350
## Installation and Setup
1451
Please apply general instructions for Redmine plugins [here](http://www.redmine.org/wiki/redmine/Plugins).
1552

16-
These plugins must be installed first.
17-
1853
Following steps are required to install the plugin:
1954
1. Clone this repository to your Redmine instance as `plugins/project_tree`:
2055

@@ -26,6 +61,8 @@ Following steps are required to install the plugin:
2661
## License
2762
This plugin is licensed under the MIT license. See LICENSE for details.
2863

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.
2966

3067
## Contributing
3168
1. Fork it
@@ -34,5 +71,4 @@ Following steps are required to install the plugin:
3471
4. Push to the branch (`git push origin my-new-feature`)
3572
5. Create new Pull Request
3673

37-
3874
[screenshot]: http://heber.it/images/github/redmine-projects-tree.png "Screen shot - Redmine Projects Treeview plugin"

init.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
Redmine::Plugin.register :project_tree do
77

88
name 'Project Tree plugin'
9-
author 'Uwe Heber'
9+
author 'Uwe Heber, Matthias Petermann'
1010
description 'This is a Redmine plugin which will turn the projects page into a tree view'
1111
version '1.0.0'
1212
url 'https://github.com/UweHeber/redmine-project-tree-plugin'
13-
author_url 'http://heber.it/about'
13+
author_url 'http://heber.it/about, http://petermann-it.de'
1414
end

0 commit comments

Comments
 (0)