Differences

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

--- plugin:redissue [2017-04-25 10:46] – [Override title] Algorythm
+++ plugin:redissue [2023-04-27 06:38] (current) – screenshot Aleksandr
@@ Line 2: / Line 2: @@
 ---- 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
 email      : ttamalfor@gmail.com
-type       : syntax,action
+type       : syntax, action
-lastupdate : 2017-04-24
+lastupdate : 2017-08-28
-compatible : Elenor of Tsort, Detritus, Hrun, Ponder Stibbons
+compatible : Frusterick Manners, Elenor of Tsort, Detritus, Hrun
 depends    :
 conflicts  :
@@ Line 17: / Line 17: @@
 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 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.
 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:plugin|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 [[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>
@@ Line 47: / Line 40: @@
 git checkout v1.5.x
 </code>
+===== Installation =====
+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
 ===== Syntax =====
@@ Line 80: / Line 77: @@
 </code>
-====Manage Multiple servers====
+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
@@ Line 105: / Line 117: @@
 </code>
-**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.
+**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:
@@ Line 115: / Line 126: @@
 <code><redissue id='#number_issue' text="the link's text" title="short_title" /></code>
-**Note:** If you use _title_ in Mulitple 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>
@@ Line 127: / Line 138: @@
 ===== 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 =====
-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.theme :**Let you choose the theme you want to display. Dokuwiki (for base theme) or Bootstrap (if you have a bootstrap theme)
@@ Line 155: / Line 166: @@
 Please report your issue or your idea at [[https://github.com/algorys/redissue/issues|Redissue]].