| Index: trunk/extensions/RT/README |
| — | — | @@ -1,4 +1,4 @@ |
| 2 | | -This is the RequestTracker (RT) extension for MediaWiki. It allows |
| | 2 | +This is the RequestTracker (RT) extension for MediaWiki. It allows |
| 3 | 3 | you to view information from RT tickets on your wiki in real time. |
| 4 | 4 | |
| 5 | 5 | Written by Greg Sabino Mullane, End Point Corporation <greg@endpoint.com> |
| — | — | @@ -23,7 +23,7 @@ |
| 24 | 24 | |
| 25 | 25 | require_once("$IP/extensions/RT/RT.php"); |
| 26 | 26 | |
| 27 | | -You should also add the global configuration values directly below |
| | 27 | +You should also add the global configuration values directly below |
| 28 | 28 | this line. Each is described below by example below: |
| 29 | 29 | |
| 30 | 30 | $wgRequestTrackerURL = 'https://rt.endpoint.com/Ticket/Display.html?id'; |
| — | — | @@ -33,34 +33,34 @@ |
| 34 | 34 | |
| 35 | 35 | $wgRequestTrackerDBconn = 'user=rt dbname=rt'; |
| 36 | 36 | |
| 37 | | -This is the connection string to get to your RT database. This is passed directly |
| | 37 | +This is the connection string to get to your RT database. This is passed directly |
| 38 | 38 | to pg_connect, so you can also use 'port' and 'host' as needed. |
| 39 | 39 | |
| 40 | 40 | $wgRequestTrackerFormats = array |
| 41 | 41 | ( |
| 42 | | - 'normal' => "Subject: <b>?subject?</b> Status:?status?", |
| | 42 | + 'normal' => "Subject: <b>?subject?</b> Status:?status?", |
| 43 | 43 | ); |
| 44 | 44 | |
| 45 | | -This is a list of specific named formats you wish to use. Items to be |
| | 45 | +This is a list of specific named formats you wish to use. Items to be |
| 46 | 46 | replaced as placeholders should be surrounded by question marks. |
| 47 | 47 | |
| 48 | 48 | |
| 49 | 49 | USAGE |
| 50 | 50 | ===== |
| 51 | 51 | |
| 52 | | -To use this extension, simply add <rt></rt> tags to the source of |
| 53 | | -your wiki. To view specific tickets, simply put the number between |
| | 52 | +To use this extension, simply add <rt></rt> tags to the source of |
| | 53 | +your wiki. To view specific tickets, simply put the number between |
| 54 | 54 | the tags like so: |
| 55 | 55 | |
| 56 | 56 | <rt>1234</rt> |
| 57 | 57 | |
| 58 | | -This will create an external link to ticket 1234. If the ticket does |
| | 58 | +This will create an external link to ticket 1234. If the ticket does |
| 59 | 59 | not exist, the non-hyperlinked text "RT #1234" will appear. |
| 60 | 60 | |
| 61 | | -You can also control what information is displayed. The best way to do |
| 62 | | -this is to create a global format by adding entries to the |
| 63 | | -$wgRequestTrackerFormats array. Placeholders should be entered as words |
| 64 | | -with question marks on both sides of them. Current information that |
| | 61 | +You can also control what information is displayed. The best way to do |
| | 62 | +this is to create a global format by adding entries to the |
| | 63 | +$wgRequestTrackerFormats array. Placeholders should be entered as words |
| | 64 | +with question marks on both sides of them. Current information that |
| 65 | 65 | can be displayed is: |
| 66 | 66 | |
| 67 | 67 | subject |
| — | — | @@ -72,56 +72,56 @@ |
| 73 | 73 | priority |
| 74 | 74 | resolved |
| 75 | 75 | |
| 76 | | -The RT links also have a balloon mouseover effect that gives all of the current |
| 77 | | -information (as of the last page load) for the ticket. This allows you to save |
| | 76 | +The RT links also have a balloon mouseover effect that gives all of the current |
| | 77 | +information (as of the last page load) for the ticket. This allows you to save |
| 78 | 78 | valuable screen real-estate. |
| 79 | 79 | |
| 80 | | -You can also generate a list of tickets, either by owner, or by queue. To view |
| | 80 | +You can also generate a list of tickets, either by owner, or by queue. To view |
| 81 | 81 | a table of all new and open tickets by a specific user, use this syntax: |
| 82 | 82 | |
| 83 | 83 | <rt o="Greg"></rt> |
| 84 | 84 | |
| 85 | | -By default, the table will show columns with the RT ticket id, the subject, |
| 86 | | -the status, and the queue. Each of these can be turned off by adding noxxx |
| 87 | | -to the inside of the rt tag. You can also add in the additional fields |
| 88 | | -'update' and 'create'. For example, the following line will show a table with |
| 89 | | -all new or open tickets owned by the user 'Greg', with no status, and |
| | 85 | +By default, the table will show columns with the RT ticket id, the subject, |
| | 86 | +the status, and the queue. Each of these can be turned off by adding noxxx |
| | 87 | +to the inside of the rt tag. You can also add in the additional fields |
| | 88 | +'update' and 'create'. For example, the following line will show a table with |
| | 89 | +all new or open tickets owned by the user 'Greg', with no status, and |
| 90 | 90 | an additional column showing the last update time: |
| 91 | 91 | |
| 92 | 92 | <rt o="greg" nostatus update></rt> |
| 93 | 93 | |
| 94 | | -The owner name is case-insensitive. Multiple owners can be separated by commas, |
| 95 | | -in which case an additional column named "Owner" will be added. This can be turned |
| | 94 | +The owner name is case-insensitive. Multiple owners can be separated by commas, |
| | 95 | +in which case an additional column named "Owner" will be added. This can be turned |
| 96 | 96 | off by adding "noowner", or forced on by using "owner". |
| 97 | 97 | |
| 98 | 98 | Rows are ordered with the most recently updated tickets at the top. |
| 99 | 99 | |
| 100 | | -In a similar way to the 'owner' query, you can search by the name of an RT queue. |
| | 100 | +In a similar way to the 'owner' query, you can search by the name of an RT queue. |
| 101 | 101 | The following line will show all open or new tickets in the sales queue: |
| 102 | 102 | |
| 103 | 103 | <rt q="sales"></rt> |
| 104 | 104 | |
| 105 | | -The queue name is case-insensitive. Multiple queues can be separated by commas, |
| 106 | | -in which case an additional column named "Queue" will be added. This can be turned |
| | 105 | +The queue name is case-insensitive. Multiple queues can be separated by commas, |
| | 106 | +in which case an additional column named "Queue" will be added. This can be turned |
| 107 | 107 | off by adding "noqueue", or forced on by using "queue". |
| 108 | 108 | |
| 109 | | -For table outputs, the status criteria can be changed from the default of |
| 110 | | -'new and open' by adding a "c" argument to tell it what criteria to use |
| | 109 | +For table outputs, the status criteria can be changed from the default of |
| | 110 | +'new and open' by adding a "c" argument to tell it what criteria to use |
| 111 | 111 | for the status. For example, to view all resolved RT ticket in the queue 'Postgres': |
| 112 | 112 | |
| 113 | 113 | <rt q="postgres" c="resolved"></rt> |
| 114 | 114 | |
| 115 | | -To add a limit to any table output, add a "l" argument as the maximum number of |
| 116 | | -sorted rows to show. Remember that rows sort with the most recently updated tickets |
| | 115 | +To add a limit to any table output, add a "l" argument as the maximum number of |
| | 116 | +sorted rows to show. Remember that rows sort with the most recently updated tickets |
| 117 | 117 | at the top. |
| 118 | 118 | |
| 119 | 119 | |
| 120 | 120 | WARNING |
| 121 | 121 | ======= |
| 122 | 122 | |
| 123 | | -These tags will query the RT database on every page load, so don't put these on |
| | 123 | +These tags will query the RT database on every page load, so don't put these on |
| 124 | 124 | very highly trafficed page unless your database can handle the load. |
| 125 | 125 | |
| 126 | | -Use of these tags is akin to making your entire RT database available to anyone who |
| | 126 | +Use of these tags is akin to making your entire RT database available to anyone who |
| 127 | 127 | can edit the wiki. Hopefully, those communities have a complete overlap. |
| 128 | 128 | |