Extension:ReaderFeedback

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual - list
Crystal Clear action run.png
ReaderFeedback

Release status: unmaintained

Implementation User interface, Special page, Database
Description Lets users and visitors rate the pages they read.
Author(s) Aaron Schulz
MediaWiki 1.15-1.19 (1.20-1.22 untested)
License GPL
Download Download 1.19 branch
Added rights

feedback

Hooks used
SkinAfterContent

SkinTemplateBuildNavUrlsNav_urlsAfterPermalink
SkinTemplateToolboxEnd
BeforePageDisplay
SpecialPage_initList

Translate the ReaderFeedback extension if possible

Check usage and version matrix; code metrics
Bugs: list open list all report

Article validation allows for readers to give feedback in the form of categorical ratings.

Setup[edit | edit source]

  • Download the latest snapshot and extract it to your extensions directory.
  • Upgrade to MediaWiki 1.15 or later
  • Make sure '../extensions/ReaderFeedback' is readable (for CSS/JS)
  • Make sure PHP has the GD libraries installed (type php -m from the command line to see installed PHP modules). In windows, this is done by un-commenting them out in php.ini. In linux, php should be compiled with it enabled ('--with-gd'). See a nice guide here.
  • Add the following line to LocalSettings.php:
require_once( "$IP/extensions/ReaderFeedback/ReaderFeedback.php" );
  • Run maintenance/update.php

Configuration[edit | edit source]

Basic settings[edit | edit source]

  • $wgFeedbackNamespaces - An array of integers (namespaces, see defines.php) that set what namespaces pages have to be in to be rateable.
  • $wgFeedbackTags - An array of tags mapped to their numeric weight. This weight is simply used to determine listings of 'overall' problematic pages. There are lists for each tag at Special:ProblemPages as well as the 'overall' list. If you value, say, "accuracy" more than "completeness", then give it more weight.

For example, to let all viewers rate pages in the Main namespace with 4 tags (reliability,completeness,npov,presentation), one would add the following to localsettings.php:

$wgGroupPermissions['*']['feedback'] = true; // Same as default
$wgFeedbackNamespaces = array( NS_MAIN );
$wgFeedbackTags = array( // Same as default
	'reliability'  => 3,
	'completeness' => 2,
	'npov'         => 2,
	'presentation' => 1
);

The integer values above are unused, but intended to be "weights" of the importance of each tag – they may be used in the future.

Advanced[edit | edit source]

See ReaderFeedback.php for a complete list of configuration options (with some explanatory comments). Be sure to change only localsettings.php to set configuration options rather than editing this file.

Use[edit | edit source]

Readers will have a small review form on the bottom of pages they have not voted on already (or where they voted on only older versions). ReaderFeedback.png

The labels for the values are set in [[MediaWiki:Readerfeedback-<tagname>]] (where tagname comes from the array key of $wgFeedbackTags.

The navigation bar/toolbox will have a "page rating" link that takes the user to Special:RatingHistory. This page show tables and time graphs of the ratings for each category, as well as the list of users that rated that page.

FRRatingGraph.PNG

Also, at Special:RatedPages, a list is maintained of pages that have received a large sample of ratings. It can be filtered based on pages with low, medium, or high ratings.

Licensing[edit | edit source]

© GPL, Aaron Schulz 2007

See also[edit | edit source]