Extension:VoteNY

From mediawiki.org
MediaWiki extensions manual
VoteNY
Release status: stable
Implementation Parser extension , Hook , Tag
Description JavaScript-based voting with the ‎<vote> tag
Author(s)
Latest version 3.2 (2021-11-24)
Compatibility policy Master maintains backward compatibility.
MediaWiki 1.39+
Database changes Yes
Tables Vote
License GNU General Public License 2.0 or later
Download
  • voteny
Quarterly downloads 26 (Ranked 124th)
Translate the VoteNY extension if it is available at translatewiki.net
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[edit]

  • Download and move the extracted VoteNY 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/VoteNY
  • Add the following code at the bottom of your LocalSettings.php file:
    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.


Configuration[edit]

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[edit]

Tags[edit]

‎<vote /> outputs a green square voting box.

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

Magic words[edit]

  • {{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[edit]

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[edit]

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.

See also[edit]

  • RatePage - Allows for voting and voting contests