DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:redissue

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
plugin:redissue [2019-02-14 15:36]
Michaelsy old revision restored (2018-05-28 21:42)
plugin:redissue [2019-10-17 10:44] (current)
Aleksandr
Line 2: Line 2:
  
 ---- plugin ---- ---- plugin ----
-description: Create link to issue of your redmine's server and display the issue's status, subject and name of it automatically. +description: Create link to issue of your redmine's server and display the issue's status, subject and name of it automatically 
-author     : Algorythm  +author     : Algorythm 
-email      : ttamalfor@gmail.com  +email      : ttamalfor@gmail.com 
-type       : syntax,action+type       : syntax, action
 lastupdate : 2017-08-25 lastupdate : 2017-08-25
 compatible : Frusterick Manners, Elenor of Tsort, Detritus, Hrun compatible : Frusterick Manners, Elenor of Tsort, Detritus, Hrun
Line 20: Line 20:
 ---- ----
  
-Redissue is a plugin for Dokuwiki who make a link beetween Dokuwiki and Redmine issues. He can get data from your redmine server and display name, status and subject of issues.+Redissue is a plugin for DokuWiki who make a link between DokuWiki and Redmine issues. He can get data from your redmine server and display name, status and subject of issues.
  
 You can also display many issues of a specific project and / or a specific tracker. You can also display many issues of a specific project and / or a specific tracker.
  
 He can manage access rights (see below) if you have API key of a Redmine's Admin account. He can manage access rights (see below) if you have API key of a Redmine's Admin account.
- 
-===== Installation ===== 
- 
-Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually. 
- 
- 
  
 ===== Requirements ===== ===== Requirements =====
  
-Redissue needs a php API to work. You have to download [[https://github.com/kbsali/php-redmine-api|PHP-Redmine-API]] inside the ROOT of redissue's install or inside ''/usr/share/php''. If you use [[plugin:redproject|redproject]] too, the second option is better, as you have just to download Php-redmine-API one time.+:!: Redissue needs a PHP API to work. You have to download [[https://github.com/kbsali/php-redmine-api|PHP-Redmine-API]] inside the ROOT of redissue's install or inside ''/usr/share/php''. If you use [[plugin:redproject|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.+Also PHP-Redmine-API requires PHP ''curl'' extension, not required by DokuWiki itself.
  
 <code bash> <code bash>
Line 46: Line 40:
 git checkout v1.5.x git checkout v1.5.x
 </code> </code>
 +
 +===== Installation =====
 +
 +Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
  
 ===== Syntax ===== ===== Syntax =====
Line 94: Line 92:
 </code> </code>
  
-====Manage Multiple servers====+==== Manage Multiple servers ====
  
   * **server**: server option override the server url and the API key defined in settings. You must define these in ''server.json'' file (located at the root of the plugin redissue). You can set as many servers as you want :-P   * **server**: server option override the server url and the API key defined in settings. You must define these in ''server.json'' file (located at the root of the plugin redissue). You can set as many servers as you want :-P
Line 131: Line 129:
 **Note:** If you use "//title//" in //Multiple Issues// syntax, this will replace the titles of all issues ! **Note:** If you use "//title//" in //Multiple Issues// syntax, this will replace the titles of all issues !
  
-====Hide / Show additional information====+==== Hide / Show additional information ====
  
-**For Dokuwiki theme only !!** (Bootstrap theme has already collapse function)+**For DokuWiki theme only!** (Bootstrap theme has already collapse function)
  
-You can hide additionnal information by setting "short" at 1 or display more with 0. This override the choice made in settings :+You can hide additional information by setting "short" at ''1'' or display more with ''0''. This override the choice made in settings:
  
 <code><redissue id='#number_issue' text="the link's text" short="1" /></code> <code><redissue id='#number_issue' text="the link's text" short="1" /></code>
Line 141: Line 139:
 ===== Preview ===== ===== Preview =====
  
-Dokuwiki style :+DokuWiki style:
  
 {{https://s28.postimg.org/9l6x5j3p9/redissue_dokuwiki.png}} {{https://s28.postimg.org/9l6x5j3p9/redissue_dokuwiki.png}}
  
-Bootstrap style :+Bootstrap style:
  
 {{https://s21.postimg.org/z9nyq9twn/redissue_bootstrap.png}} {{https://s21.postimg.org/z9nyq9twn/redissue_bootstrap.png}}
Line 151: Line 149:
 ===== Configuration and Settings ===== ===== Configuration and Settings =====
  
-You can configure the plugin in the Config Manager of DokuWiki :+You can configure the plugin in the Config Manager of DokuWiki:
  
-  * **redissue.url :** Put your redmine's url server, without a slash ending. Example : <code>http://myredmine.com</code> This setting can be override by //server// option.+  * **redissue.url :** Put your redmine's url server, without a slash ending. Example: <code>http://myredmine.com</code> 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 : <code>http://www.example.com/image.png</code>   * **redissue.img :** Maybe you have a custom icon for your Redmine installation. You can put image'url here. Example : <code>http://www.example.com/image.png</code>
   * **redissue.theme :**Let you choose the theme you want to display. Dokuwiki (for base theme) or Bootstrap (if you have a bootstrap theme)   * **redissue.theme :**Let you choose the theme you want to display. Dokuwiki (for base theme) or Bootstrap (if you have a bootstrap theme)
Line 169: Line 167:
  
 Please report your issue or your idea at [[https://github.com/algorys/redissue/issues|Redissue]]. Please report your issue or your idea at [[https://github.com/algorys/redissue/issues|Redissue]].
- 
- 
  
  
plugin/redissue.txt · Last modified: 2019-10-17 10:44 by Aleksandr