Name |
Date |
Size |
#Lines |
LOC |
||
---|---|---|---|---|---|---|
.. | 30-Apr-2025 | - | ||||
conf/ | H | 03-May-2018 | - | 21 | 8 | |
images/ | H | 03-May-2018 | - | |||
lang/ | H | 03-May-2018 | - | 74 | 58 | |
README.md | H A D | 09-Jan-2018 | 3.3 KiB | 98 | 67 | |
plugin.info.txt | H A D | 09-Jan-2018 | 140 | 8 | 6 | |
server.json | H A D | 09-Jan-2018 | 118 | 7 | 6 | |
style.css | H A D | 09-Jan-2018 | 3 KiB | 195 | 162 | |
syntax.php | H A D | 09-Jan-2018 | 15.9 KiB | 333 | 274 |
README.md
1# Plugin Redproject 2 3This plugin display a roadmap and some other informations of your project in Dokuwiki : 4* Name and Description of project 5* Link to homepage define in Redmine 6* Versions available (with creation and update date, total issues, open and closed) 7* Members and Roles of the project 8* Some different links to redmine, like the issues, subproject, mail of members,... 9* Compatible with [Bootstrap](http://getbootstrap.com/) (need [Bootstrap3 Template](https://github.com/LotarProject/dokuwiki-template-bootstrap3/)). 10* Handle multiple redmine server 11 12## Requirements 13 14Redproject needs [Php-Redmine-API](https://github.com/kbsali/php-redmine-api) to work. Download it inside your shared folder of php, like ``/usr/share/php`` or in the redproject's folder. If you use [redissue](https://www.dokuwiki.org/plugin:redissue) the first option is better, as you have just to install it one time. 15 16```bash 17$ mkdir vendor 18$ cd vendor 19$ git clone https://github.com/kbsali/php-redmine-api.git 20$ cd php-redmine-api 21$ git checkout v1.5.5 22``` 23 24Don't forget to install the requirements of PhP-Redmine-API : 25 26```bash 27$ sudo apt-get install php5-curl php5-common 28``` 29 30## Install 31 32Download this plugin into your ``${dokuwiki_root}/lib/plugins`` folder and restart dokuwiki. 33 34## Configuration 35 36You can configure the plugin in the Config Manager of DokuWiki : 37 38* redproject.url : Put your Redmine's url server, without a slash ending. Example : ``http://myredmine.com``. This setting can be override by _server_ option. 39* redproject.API : Set your Redmine API's key, preference Administrator key. This setting can be override by _server_ option. 40* redproject.view : Choose the view you want to display. This will depend on the wiki user's access rights in Redmine. 41 * Impersonate : select this if your wiki's users have the same UID as Redmine's users. e.g. : LDAP authentication. Redproject then will manage rights based on private or public projects. 42 * Userview : doesn't manage access rights and display project even if it's in private project. 43 44## Syntax 45 46There is two way to use this plugin : 47 48### Basic Syntax : 49 50```php 51<redproject proj="identifier_project" /> 52``` 53 54Where **proj** value is the project identifier (Available in the settings of redmine project). 55 56### Multiple Servers 57 58You can, as in [redissue](https://github.com/algorys/redissue), select another redmine server in syntax. This server should be defined in the _server.json_ file of the plugin. 59 60Example of _server.json_ file: 61 62```json 63{ 64 "first": { 65 "url": "http://myfirst.redmine.com", 66 "api_token": "abcdefghijklmnopqrstuvwxyz0123456789" 67 }, 68 "second": { 69 "url": "http://mysecond.redmine.com", 70 "api_token": "zyxwvutsrqponmlkjihgfedcba9876543210" 71 } 72} 73``` 74 75Then simply add your server in redproject syntax: 76 77```php 78<redproject proj="identifier_project" server="first" /> 79``` 80 81**Note:** By default, redproject will take the data defined in Dokuwiki settings. 82 83## Preview 84 85Here is a preview of redproject : 86 87Name, homepage and description of project: 88 89 90Each Versions with their issues progression: 91 92 93Last détails and Members. 94 95 96For further information, see also [Redproject on dokuwiki.org](https://www.dokuwiki.org/plugin:redproject) 97 98