ReviewBoardPlugin

This is a plugin used to display the pending requests of different users registered in the Review Board. All pending review requests from a particular user will be displayed. The details include the summary, last time updated and the group to which it belongs.It also includes the url to the pending request, by which the user can navigate easily. All pending requests to a particular users will also be displayed in a similar fashion.

Usage

Anywhere in a topic

%GET_PENDING%

Parameter	Description	Default
name	User name registered in Review Board	All users
host	The base url in which the review board has been installed	none
order	If set to "from", pending review requests from a particular user will be described If set to "to" , pending review requests to a particular user will be displayed	from

Examples

Here is the screen shot of the working of the plugin: The pending review requests from and to a user 'SrikanthR' are displayed in the following fashion :

If properly installed, you will see all the pending review requests in the review board. %GET_PENDING{host="10.232.80.17"}%

Plugin Settings

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = To retrieve the pending review requests for the registered users in Review Board
• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

• Download the ZIP file from the Plugin Home (see below)
• Unzip ReviewBoardPlugin.zip in your twiki installation directory. Content:

File:	Description:
data/TWiki/ReviewBoardPlugin.txt	Plugin topic
data/TWiki/ReviewBoardPlugin.txt,v	Plugin topic repository
lib/TWiki/Plugins/ReviewBoardPlugin.pm	Plugin Perl module
pub/ReviewBoardPlugin/PendingReviewRequest.png	Screenshot

• Configure the Plugin:
  • TWiki 4.0 and up: Run the configure script to enable the Plugin
  • Change the Plugin settings as needed

Plugin Info

Plugin Author:	TWiki:Main.SrikanthRevanuru
Copyright:	© 2007, TWiki:Main.SrikanthRevanuru
License:	GPL (GNU General Public License)
Plugin Version:	28 Jul 2008 (V1.000)
Change History:
28 Jul 2008:	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.1
CPAN Dependencies:	LWP::UserAgent - libwww-perl-5.81
Other Dependencies:	none
Perl Version:	5.005
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/ReviewBoardPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/ReviewBoardPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/ReviewBoardPluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- TWiki:Main.SrikanthRevanuru - 28 Jul 2008