Jump to content

Extension:AJAXPoll

From mediawiki.org
MediaWiki extensions manual
AJAXPoll
Release status: stable
Implementation Parser extension
Description Allows AJAX-based polls with ‎<poll> tag
Author(s)
Latest version 2.3.0 (2020-02-24)
MediaWiki 1.39.10+
Tables ajaxpoll_info
ajaxpoll_vote
License GNU Free Documentation License
Download
Example Any ShoutWiki site
Quarterly downloads 22 (Ranked 115th)
Translate the AJAXPoll extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

The AJAXPoll extension allows one or more AJAX-based polls on MediaWiki pages with ‎<poll> tag.

Installation

  • Download and move the extracted AJAXPoll 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/AJAXPoll
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'AJAXPoll' );
    
  • Run the update script which will automatically create the necessary database tables that this extension needs. Configure at your convenience.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

# if you want to restrict the poll
# use the following code lines after calling the AJAXPoll extension
# to restrict to user group (example)

# The 'ajaxpoll-view-results-before-vote' group permission allows the specified
# group members to view poll results even without having voted
# but only if the high-level group permission 'ajaxpoll-vote' allows to view
# results in general.
#
# This 'ajaxpoll-view-results-before-vote' can be overwritten with the specific
# per-poll setting "show-results-before-voting" which takes precedence over the
# group permission.
#
# permission 'ajaxpoll-view-results' >>
# >> per-poll setting "show-results-before-voting" (if present)
# >> permission 'ajaxpoll-view-results-before-vote'

# anons
# default: anons cannot vote and will never see results
$wgGroupPermissions['*']['ajaxpoll-vote'] = false;
$wgGroupPermissions['*']['ajaxpoll-view-results'] = false;
$wgGroupPermissions['*']['ajaxpoll-view-results-before-vote'] = false;

# users
# default: users can vote and can see poll results - when they have voted
$wgGroupPermissions['user']['ajaxpoll-vote'] = true;
$wgGroupPermissions['user']['ajaxpoll-view-results'] = true;

If you want to disable the automatic tracking category then set the text of system message "MediaWiki:Ajaxpoll-tracking-category" in your wiki to "-" (minus).

Usage

Syntax

<poll>
Question
Choice 1
Choice 2
Choice 3
Choice 4
</poll>

Example

<poll>
Do you like this poll ?
Yes, it is awesome.
Yes.
No, I do not like polls.
I have no idea, what this means.
</poll>

If you want this, you can allow or deny the result-viewing before voting per-poll by adding the show-results-before-voting parameter in the opening tag:

<poll show-results-before-voting>
<poll show-results-before-voting=1>
<poll show-results-before-voting=0>

If the first line after ‎<poll> is "STATS", then some statistics about the wiki and its polls will be displayed. These statistics are not localizable and this whole feature will probably be removed (or at least refactored, but probably removed) in the future.