Jump to content

Extension:ArticleRatings

From mediawiki.org
MediaWiki extensions manual
ArticleRatings
Release status: stable
Implementation Tag , Special page
Description Adds a complex interface for giving pages ratings.
Author(s) Adam Carter
Latest version 2.6
MediaWiki >= 1.39.0
Database changes Yes
Tables ratings
License GNU General Public License 2.0 or later
Download
README
Example Brickimedia
  • $wgAREUseInitialRatings
  • $wgARENamespaces
‎<rating />
change-rating
Quarterly downloads 3 (Ranked 121st)
Translate the ArticleRatings extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

The ArticleRatings extension adds an interface for rating pages. Privileged users (those with the change-rating user right, by default members of the reviewers group) will see a link on the toolbox on supported skins and they will be able to use the interface at Special:ChangeRating to change pages' ratings.

This extension was developed for Brickimedia, and is not as portable as it could be.

Installation

[edit]
  • Download and move the extracted ArticleRatings folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ArticleRatings
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'ArticleRatings' );
    
    Configure MediaWiki:Are-ratings interface message on-wiki; see #Messages below for more info. This is not optional!
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

User rights

[edit]
  • change-rating – new user right allows user to change the ratings of pages.

Tags

[edit]

‎<rating /> adds the rating of a page to a page. ‎<rating /> on its own will add the rating of the page it is on, and <rating page="title" /> will give the rating of title.

Special pages

[edit]
  • Special:ChangeRating – interface for changing pages' ratings.
  • Special:MassRatings – interface for getting the ratings of many pages at once.

Messages

[edit]
  • MediaWiki:Are-ratings – JSON file giving the name, codename (has to be 2 characters long), image, and link, for each rating. Should be an array of objects, in PHP-valid JSON. See Brickipedia for an example. The codename is just a 2 character string used by the software to identify the ratings, it doesn't matter what it is, as long as each rating's is different. Whichever rating comes first will be the default rating (the one used before the rating has been changed)

Variables

[edit]
  • $wgARENamespaces = $wgContentNamespaces; - Array of namespace numbers/constants that are allowed to have ratings on them.
  • $wgAREUseInitialRatings = false; - If true, the ratings tag has an init-rating parameter that wil set the initial rating to the codename supplied, not the default. Not recommended for production use, but can be used as a workaround to allow bots to use the extension.