PeerPlugin

Rate TWiki pages for quality of content and relevance

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/TWiki05x01/PeerPlugin/peerreview.gif
  • Set RATINGSUFFIX =
  • #Set LISTICONPREFIX = /p/pub/TWiki05x01/PeerPlugin/dot_
  • #Set LISTICONHEIGHT = 12
  • #Set LISTICONWIDTH = 64
  • #Set RATINGICONPREFIX = /p/pub/TWiki05x01/PeerPlugin/rating
  • #Set RATINGICONHEIGHT = 5
  • #Set RATINGICONWIDTH = 42
  • Set LISTICONPREFIX = /p/pub/TWiki05x01/PeerPlugin/star_
  • Set LISTICONHEIGHT = 13
  • Set LISTICONWIDTH = 75
  • Set RATINGICONPREFIX = /p/pub/TWiki05x01/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

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