Extension:JSKitRating

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

Release status: stable

Description Provides integration with JS-Kit Ratings and JS-Kit Score AJAX based social rating/scoring tools.
Author(s) Jean-Lou Dupont
Latest version 1.4.0
MediaWiki 1.11, 1.12
License No license specified
Download SVN
See SVN ($Id: JSKitRating.doc.wikitext 1015 2008-04-10 23:31:38Z jeanlou.dupont $)
Example Example
author's sandbox

Translate the JSKitRating extension if possible

Check usage and version matrix; code metrics

Purpose[edit | edit source]

Provides integration with JS-Kit Ratings and JS-Kit Score AJAX based social rating/scoring tools. PLEASE NOTE: The JS-kit modules are being discontinued [1]

Usage[edit | edit source]

Just use the following parser function {{#jskitrating: [optional parameters] }} on the desired wiki page.

Use the noscript parameter to control when the JS script should be included. Useful when putting together aggregate ratings page with the path parameter.

Parameters[edit | edit source]

For a complete description, please see JS-Kit Ratings Customization.

Parameter Description
noscript Set to true or 1 if the JS script should be omitted
notop You can prevent a particular instance of Ratings from entering the Top list
imageurl You can replace starlet images with your own art
imagesize Complement to imageurl
path You can rate multiple items on the same page
starColor Affects the color of the community rating
userColor Sets the color of the particular user's rating
view Change the display mode between split and combo or score

Example[edit | edit source]

{{#jskitrating:view=score}}


Dependency[edit | edit source]


Installation[edit | edit source]

See the Mediawiki Extension table entry "download" above.[1]

LocalSettings.php[edit | edit source]

Extension:ExtensionManager: See footnote[2]

require_once( "$IP/extensions/JSKitRating/JSKitRating.php" );
  • Since this Extensions is depending on StubManager, add the line after the StubManager include, or else your Wiki won't work.

PEAR[edit | edit source]

PEAR is a repository of PHP software code.

pear channel-discover mediawiki.googlecode.com/svn
  • Install extension through PEAR:
pear install mediawiki/JSKitRating
  • Add the following to LocalSettings.php[2][3]:
require 'MediaWiki/JSKitRating/JSKitRating.php';
  • Note that the required version of PEAR must be respected. Currently, the minimum version of PEAR usable with this channel is v1.6.2. Perform the following command to upgrade to the latest version of PEAR:
pear upgrade pear

Upgrades through PEAR[edit | edit source]

Sometimes, it is necessary to clear PEAR's cache in order to perform upgrades.

pear clear-cache

or use the force method:

pear upgrade --force mediawiki/JSKitRating

PEAR Web Frontend[edit | edit source]

For easier remote package management, PEAR Frontend WEB can be installed. Installation notes can be found here. An example of the WEB frontend is available here.

RSS feed[edit | edit source]

To keep up-to-date with this channel, use the following RSS feed__Rss2.jpg.

Notes[edit | edit source]

Other Extensions From the same author[edit | edit source]

Consult User Jldupont's page.


  1. The most recent release is always available through the extension's PEAR and SVN repositories. This page is not necessarily up-to-date.
  2. 2.0 2.1 2.2 Extension:ExtensionManager does not require any modification to LocalSettings.php because ExtensionManager includes the extension.
    Note that if PHP code caching is in place (e.g. APC, eAccelerator), then to successfully complete the installation a cache flush might be needed.
  3. Modifications to LocalSettings.php is only necessary if not using Extension:ExtensionManager

History[edit | edit source]

Release Notes
1.0.0 Initial Release
1.1.0 Added support for optional parameters
1.2.0 Removed hardcoded parameters title and permalink
1.3.0 Added check for only including the script once per page, Added noscript parameter
1.4.0 Added notop parameter

See also[edit | edit source]