Extension:VoteNY

From MediaWiki.org
Jump to navigation Jump to search

Other languages:
English • ‎dansk • ‎日本語
MediaWiki extensions manual
OOjs UI icon advanced.svg
VoteNY
Release status: stable
VoteNY.png
Implementation Parser extension, Hook, Tag
Description JavaScript-based voting with the <vote> tag
Author(s)
Latest version 2.9.4 (2018-06-27)
Compatibility policy master
MediaWiki 1.25+
Database changes Yes
Tables Vote
License GNU General Public License 2.0 or later
Download
Parameters
  • $wgVoteDirectory
Added rights
voteny
Hooks used
ParserFirstCallInit
RenameUserSQL
LoadExtensionSchemaUpdates
ParserGetVariableValueSwitch
MagicWordwgVariableIDs
Translate the VoteNY extension if it is available at translatewiki.net
Check usage and version matrix.
Issues Open tasks · Report a bug

The VoteNY a.k.a Vote extension adds the <vote> parser hook tag to allow voting on articles where the tag is present.

Installation

  • Download and place the file(s) in a directory called VoteNY in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'VoteNY' );
    
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.27 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension() If you need to install this extension on these earlier versions (MediaWiki 1.27 and earlier), instead of wfLoadExtension( 'VoteNY' );, you need to use:

require_once "$IP/extensions/VoteNY/VoteNY.php";

Configuration

This extension adds one new user right, voteny, which is required in order to vote. By default, anonymous users do not have this right and thus they cannot vote but registered users can. To allow anonymous users to vote, add the following to your LocalSettings.php:

$wgGroupPermissions['*']['voteny'] = true;

Usage

Tags

<vote /> outputs a green square voting box.

<vote type=1 /> outputs five voting stars.

Magic words

  • {{NUMBEROFVOTES}}: Returns the entire number of votes on the wiki.
  • {{NUMBEROFVOTESPAGE}}: Returns the number of votes on the current page.
  • {{NUMBEROFVOTESPAGE:<page>}}: Returns the number of votes on the given page.

The magic word {{NUMBEROFVOTES}} can be used to display the number of votes in the database; this number is cached (in memcached ) for 24 hours, so it's not totally up-to-date.

Special page

The special page Special:TopRatings displays the highest rated pages on the wiki. It supports filtering by category and namespace and its output can be embedded on wiki pages, so {{Special:TopRatings/Adventure Games/0/10}} will show 10 ratings where the pages are in the "Adventure Games" category and the pages are in the main (0) namespace.

Internationalization

Message English Description
voteny-link Vote
voteny-unvote-link unvote Displayed to the user after their vote has been successfully added.
voteny-community-score community score: $1 "community score" is the average score of the page in question
voteny-ratings {{PLURAL:$1|one rating|$1 ratings}} $1 is the number of ratings, if said number is greater than 1.
voteny-remove remove
voteny-gave-this you gave this a $1 $1 is the score you gave to the page, for example 5 or 3.50.
voteny-votes {{PLURAL:$1|one vote|$1 votes}} $1 is the number of votes.
topratings Top Ratings Title of Special:TopRatings, will be shown on the listing of special pages at Special:SpecialPages and on Special:TopRating itself.
topratings-no-pages No top rated pages. Shown on Special:TopRatings if there are absolutely no pages that have been rated yet (as is the case usually right after installing the extension).
right-voteny Vote pages Displayed on Special:ListGroupRights.