PeerPlugin

Introduction

This plugin enables TWiki users to rate any topic for quality of content and relevance of the topic across their TWiki community. Several display methods are provided:

• A star rating is inserted in the topic header
• A Review link on each topic shows a list of the current reviews
• A link on a user page shows a list of reviews made by that person
• A ratings statistics topic shows an overall summary of reviews by topic

This plugin also allows members of the TWiki community to rate any web page - and can be used to focus attention on the best (and worst) pages out there.

Please note that this plugin uses a MySQL database for storage of review data. Installation help is provided in these topics (included in the install set):

• PeerReviewInstall
• PeerReviewMySQLSetUp
• PeerReviewDbiDbdSetUp
• PeerReviewExamples

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %PEERPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Rate TWiki pages for quality of content and relevance

• Settings for rating:
  • Set LINKICON = /p/pub/TWiki06x01/PeerPlugin/peerreview.gif
  • Set RATINGSUFFIX =
  • #Set LISTICONPREFIX = /p/pub/TWiki06x01/PeerPlugin/dot_
  • #Set LISTICONHEIGHT = 12
  • #Set LISTICONWIDTH = 64
  • #Set RATINGICONPREFIX = /p/pub/TWiki06x01/PeerPlugin/rating
  • #Set RATINGICONHEIGHT = 5
  • #Set RATINGICONWIDTH = 42
  • Set LISTICONPREFIX = /p/pub/TWiki06x01/PeerPlugin/star_
  • Set LISTICONHEIGHT = 13
  • Set LISTICONWIDTH = 75
  • Set RATINGICONPREFIX = /p/pub/TWiki06x01/PeerPlugin/star_
  • Set RATINGICONHEIGHT = 13
  • Set RATINGICONWIDTH = 75

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 Plugins web (see below)
• Unzip that file and follow the PeerReviewInstall instructions

Plugin Info

Plugin Author:	TWiki:Main.SteveRoe under contract to DrKW
Copyright:	© 2001 DrKW © 2007-2011 TWiki:TWiki.TWikiContributor
License:	GPL (GNU General Public License)
Plugin Version:	2011-07-21
Change History:
2011-07-21:	TWikibug:Item6771: Code-refactor: Use only official TWiki::Func API; change global package variables from "use vars" to "our -- TWiki:Main.PeterThoeny
2011-02-01:	TWikibug:Item6638: Doc improvements; XHTML fixes; changing TWIKIWEB to SYSTEMWEB -- TWiki:Main.PeterThoeny
2001-08-22:	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.1
CPAN Dependencies:	DBI, DBD (MySQL)
Other Dependencies:	MySQL
Perl Version:	5.005
Benchmarks:	GoodStyle nn%, FormattedSearch nn%, PeerPlugin nn%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/PeerPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/PeerPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/PeerPluginAppraisal

Related Topics: PeerPluginExtForm, PeerPluginExtView, PeerPluginForm, PeerPluginUser, PeerPluginView, PeerReviewDbiDbdSetUp, PeerReviewExamples, PeerReviewInstall, PeerReviewMySQLSetUp, PeerReviewStats, TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences