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 revisionPrevious revision
Next revision
Previous revision
plugin:redissue [2016-12-23 15:10] Algorythmplugin:redissue [2023-04-27 06:38] (current) – screenshot 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 : 2016-12-23 +lastupdate : 2017-08-28 
-compatible : Elenor of Tsort, Detritus, Hrun, Ponder Stibbons+compatible : Frusterick Manners, Elenor of Tsort, Detritus, Hrun
 depends    :  depends    : 
 conflicts  conflicts 
Line 17: Line 17:
 sourcerepo : https://github.com/algorys/redissue/ sourcerepo : https://github.com/algorys/redissue/
  
-screenshot_img : http://s10.postimg.org/3jsjjq8sp/redissue2.png+screenshot_img : https://trello.com/1/cards/6449fa70f134be7d829c4018/attachments/6449fb51279b618daa2caf3a/download/dokuwiki-plugin-redissue_bootstrap-style.png
 ---- ----
  
-Redissue is a plugin for Dokuwiki who make a link beetween Dokuwiki and Redmine issue. He can get data from your redmine server and display name, status and subject of your issue.+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.
  
 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 =====+===== Requirements =====
  
-Download this plugins into your ''${dokuwiki_root}/lib/plugins'' folder and restart dokuwiki.+:!: 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.
  
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL abovewhich points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.+Also PHP-Redmine-API requires PHP ''curl'' extensionnot required by DokuWiki itself.
  
 +<code bash>
 +mkdir vendor
 +cd vendor
 +git clone https://github.com/kbsali/php-redmine-api.git
 +cd php-redmine-api
 +# Go to last version. Use "git describe --abbrev=0" to see last tag.
 +git checkout v1.5.x
 +</code>
  
-===== Requirements ===== +===== Installation =====
-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.+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
  
-'' 
-$ mkdir vendor \\ 
-$ cd vendor \\ 
-$ git clone <nowiki>https://github.com/kbsali/php-redmine-api.git</nowiki> \\ 
-$ cd php-redmine-api \\ 
-$ git checkout v1.5.5 \\ 
-'' 
 ===== Syntax ===== ===== Syntax =====
  
-  * First syntax:+==== Single Issue Syntax====
  
-<code><redissue id='#number_issue' text="text if no Rights or API" /></code>+<code php> 
 +<redissue id='#number_issue' text="text if no Rights or API" /> 
 +</code>
  
-**Note :** The ''text'' parameter only appears if the user has no rights to see the issue or if no API key is recorded.+**Note :** The ''text'' parameter only appears if the user has no rights to see the issue, if issue does not exist or if no API key is recorded.
  
-  * Second Syntax:+====Multiple Issues Syntax====
  
-**Note :** This syntax is only needed if you want add ''additional notes''. Description of issue is already displayed by Redissue.+If you want to get all issues of a specific project and/or a specific tracker, it's also possible. You've 2 other options:
  
-<code><redissue id='#number_issuetext="text if no Rights or API"> Your description...</redissue></code>+    * **project**: the right identifier of the project (Available in the settings of redmine project): ''project="myproject"'' 
 +    * **tracker**: the identifier number of your tracker(You can found this number if you look at the number in the link of a tracker): ''tracker="3"''
  
-====Multiple servers====+In this case, the **two parameters** must be set, but one can be empty. E.g: if you want to have all issues of a project for all trackers, you can leave tracker empty.
  
-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+    * **limit**: set the number of issues displayed. if not set, default is 25. 
 + 
 +Examples: 
 + 
 +<code php> 
 +// Display the first 25 issues with tracker 1 for project "myproject" 
 +<redissue project="myproject" tracker="1" /> 
 +// Display the first 25 issues for project "myproject" 
 +<redissue project="myproject" tracker="" /> 
 +// Display the first 50 issues with tracker 4 for all projects (if you have rights) 
 +<redissue project="" tracker="4" limit="50" /> 
 +</code> 
 + 
 +You can also sort the issues according to your interests. 
 + 
 +  * **sort**: choose how issues will be displayed. By default they are displayed by id number, from the most recent to the oldest (descending). 
 + 
 +You can choose to sort by : id, subject, project, tracker, ... 
 + 
 +Examples: 
 + 
 +<code php> 
 +// Sort issue by ascending "id", for project "myproject" and tracker "1" 
 +<redissue project="myproject" tracker="1" sort="id" /> 
 +// Sort issue by "subject" for project "myproject" and all trackers 
 +<redissue project="myproject" tracker="" sort="subject"/> 
 +</code> 
 + 
 +==== 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
  
 Example of ''server.json'' file: Example of ''server.json'' file:
Line 78: Line 113:
 Then simply add the name of server you want to reach: Then simply add the name of server you want to reach:
  
-<code><redissue server="first" id='#number_issue' text="the link's text" /></code>+<code php> 
 +<redissue server="first" id='#number_issue' text="the link's text" /> 
 +</code>
  
-**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.+**Note:** If server key is wrong (e.g: call //flirt// instead of //first//), redissue will take the one who is set in dokuwiki settings. If all urls or API tokens are wrong, an error message will be displayed instead of redissue.
  
  
- +==== Override title ====
-====Override title====+
  
 If you wish to override title, simply add title: If you wish to override title, simply add title:
Line 90: Line 126:
 <code><redissue id='#number_issue' text="the link's text" title="short_title" /></code> <code><redissue id='#number_issue' text="the link's text" title="short_title" /></code>
  
-====Hide Show additional information====+**Note:** If you use "//title//" in //Multiple Issues// syntax, this will replace the titles of all issues !
  
-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 :+==== Hide / Show additional information ==== 
 + 
 +**For DokuWiki theme only!** (Bootstrap theme has already collapse function) 
 + 
 +You can hide additional information by setting "shortat ''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 98: Line 138:
 ===== Preview ===== ===== Preview =====
  
-Dokuwiki style :+DokuWiki style:
  
-{{https://raw.githubusercontent.com/algorys/redissue/master/images/redissue_dokuwiki.png}}+{{https://trello.com/1/cards/6449fa70f134be7d829c4018/attachments/6449fb527a152e172c5618ab/download/dokuwiki-plugin-redissue_dokuwiki-style.png?recache}}
  
-Bootstrap style :+Bootstrap style:
  
-{{https://raw.githubusercontent.com/algorys/redissue/master/images/redissue_bootstrap.png}}+{{https://trello.com/1/cards/6449fa70f134be7d829c4018/attachments/6449fb51279b618daa2caf3a/download/dokuwiki-plugin-redissue_bootstrap-style.png?recache}}
  
 ===== 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 126: Line 166:
  
 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.1482502217.txt.gz · Last modified: 2016-12-23 15:10 by Algorythm

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki