DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:redissue

Redissue Plugin

Compatible with DokuWiki

  • 2017-02-19 "Frusterick Manners" unknown
  • 2016-06-26 "Elenor Of Tsort" yes
  • 2015-08-10 "Detritus" yes
  • 2014-09-29 "Hrun" yes

plugin Create link to issue of your redmine's server and display the issue's status, subject and name of it automatically.

Last updated on
2016-12-23
Provides
Syntax, Action
Repository
Source

Tagged with bootstrap, issue, redmine

Redissue is a plugin for Dokuwiki who make a link beetween Dokuwiki and a Redmine issue. He can get data from your redmine server and display name, status and subject of your issue.

He can manage access rights (see below) if you have API key of a Redmine's Admin account.

Installation

Download this plugins into your ${dokuwiki_root}/lib/plugins folder and restart dokuwiki.

Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.

Requirements

Redissue needs a php API to work. You have to download PHP-Redmine-API inside the ROOT of redissue's install or inside /usr/share/php. If you use redproject too, the second option is better, as you have just to download Php-redmine-API one time.

Also PHP-Redmine-API requires PHP curl extension, not required by dokuwiki itself.

$ mkdir vendor
$ cd vendor
$ git clone https://github.com/kbsali/php-redmine-api.git
$ cd php-redmine-api
$ git checkout v1.5.5

Syntax

  • First syntax:
<redissue id='#number_issue' text="text if no Rights or API" />

Note : The text parameter only appears if the user has no rights to see the issue or if no API key is recorded.

  • Second Syntax:

Note : This syntax is only needed if you want add additional notes. Description of issue is already displayed by Redissue.

<redissue id='#number_issue' text="text if no Rights or API"> Your description...</redissue>

Multiple servers

Server option override the server url and the API key. You must define these in server.json file at root of redissue folder. You can set as many servers as you want :-P

Example of server.json file:

{
    "first": {
        "url": "http://myfirst.redmine.com",
        "api_token": "abcdefghijklmnopqrstuvwxyz0123456789"
    },
    "second": {
        "url": "http://mysecond.redmine.com",
        "api_token": "zyxwvutsrqponmlkjihgfedcba9876543210"
    }
}

Then simply add the name of server you want to reach:

<redissue server="first" id='#number_issue' text="the link's text" />

Note: If server key is bad (e.g: call _flirt_ instead _first_), redissue take the one who is set in dokuwiki settings. If url or api_token are wrong, an error message is display instead of redissue.

Override title

If you wish to override title, simply add title:

<redissue id='#number_issue' text="the link's text" title="short_title" />

Hide / Show additional information

For Dokuwiki theme (Bootstrap theme has already collapse function), you can hide additionnal information to make it short at 1 or display more with 0. This override the choice made in settings :

<redissue id='#number_issue' text="the link's text" short="1" />

Preview

Dokuwiki style :

Bootstrap style :

Configuration and Settings

You can configure the plugin in the Config Manager of DokuWiki :

  • redissue.url : Put your redmine's url server, without a slash ending. Example :
    http://myredmine.com

    This setting can be override by server option.

  • redissue.img : Maybe you have a custom icon for your Redmine installation. You can put image'url here. Example :
    http://www.example.com/image.png
  • redissue.theme :Let you choose the theme you want to display. Dokuwiki (for base theme) or Bootstrap (if you have a bootstrap theme)
  • redissue.API : Set your Redmine API's key, preference Administrator key. This setting can be override by server option.
  • redissue.view : Choose the view you want to display. This will depend on the wiki user's access rights in Redmine.
    • Impersonate : select this if your wiki's users have the same UID as Redmine's users. e.g. : LDAP authentication. Redissue then will manage rights based on private or public projects.
    • Userview : doesn't manage access rights and display issue even if it's in private project.
  • redissue.short : Check this box if you want display redissue in short mode(for Dokuwiki theme only).

Change Log

Known Bugs and Issues

Please report your issue or your idea at Redissue.

plugin/redissue.txt · Last modified: 2016-12-23 15:10 by Algorythm