Open main menu

Extension:Reviews

Note: this extension is not ready for initial release yet (although it's close) and I'm no longer working on it. Feel free to get the code and finish it up. Or to try it out, but be warned, it is not really production ready.


MediaWiki extensions manual
OOjs UI icon advanced.svg
Reviews
Release status: beta
Review.png
Implementation Special page, Ajax, User interface, API
Description ...
Author(s) Jeroen De Dauw
MediaWiki 1.18.0+
PHP 5.3+
Database changes Yes
License GNU GPL v3+
Download
Added rights
  • reviewsadmin
  • postreview
  • flagreview
  • reviewreview
Hooks used
LoadExtensionSchemaUpdates
UnitTestsList
PersonalUrls
GetPreferences
BeforePageDisplay
ParserFirstCallInit
OutputPageParserOutput
Translate the Reviews extension if it is available at translatewiki.net
Check usage and version matrix.
Issues Open tasks · Report a bug

Contents

AboutEdit

The Reviews extension allows users to post Reviews on articles that have been marked as reviewable (using the __REVIEWABLE__ magic word) with one or more ratings. These articles also list previously posted reviews. Authors can edit their reviews and everyone can flag their reviews for review. Admins can approve and remove reviews.

Feature overviewEdit

  • People can post reviews on articles with one or more ratings attached.
  • Review authors can view and edit their reviews.
  • People with the can flag reviews.
  • Admins can approve and delete reviews.
  • Reviews can be sorted and filtered on various criteria.

RequirementsEdit

Reviews requires:

InstallationEdit

Once you have downloaded the code, place the Reviews directory within your MediaWiki 'extensions' directory. Then add the following code to your LocalSettings.php file:

# Reviews
require_once( "$IP/extensions/Reviews/Reviews.php" );

The final step is running the MediaWiki setup script update.php, which can be found in the maintenance directory of your MediaWiki install. Via the command line, this is typically done with:

php update.php

ConfigurationEdit

Configuration of Reviews is done by assigning to $egReviewsSettings in your LocalSettings.php file. The options are listed below and their default is set in the Reviews settings file. You should NOT modify the settings file, but can have a look at it to get an idea of how to use the settings, in case the below descriptions do not suffice.

Example of how to change a setting:

$egReviewsSettings['reviewDeletionEnabled'] = false;

Available settings:

Name Type Default Description
reviewDeletionEnabled boolean true If deletion of reviews should be enabled
enableTopLink boolean true If the link to MyReviews in the top menu should be enabled
categoryRatings array array() Adittional rating types per category. Example:
$egReviewsSettings['categoryRatings'] = array(
	'Hotels' => array(
		'Price' => 'Price',
		'Comfort' => 'Comfort',
	),
);

Furthermore, you can set the default values of some user preferences, done by assigning to $wgDefaultUserOptions.

Name Type Default Description
reviews_showtoplink boolean true Show the toplink (if enabled) by default?
reviews_showcontrol boolean true Show the review submission control by default?
reviews_showedit boolean false Show the review edit control by default?

UsageEdit

Put __REVIEWABLE__ on the wiki pages for which users should be able to post reviews.


InternationalizationEdit

Reviews is fully internationalized. Translation of Reviews messages is done through translatewiki.net. The translation for this extension can be found here. To add language values or change existing ones, you should create an account on translatewiki.net, then request permission from the administrators to translate a certain language or languages on this page (this is a very simple process). Once you have permission for a given language, you can log in and add or edit whatever messages you want to in that language.

AuthorsEdit

Reviews has been written by Jeroen De Dauw.

ScreenshotsEdit

See alsoEdit