Extension:QuickSurveys

MediaWiki extensions manual
OOjs UI icon advanced.svg
QuickSurveys
Release status: stable
Implementation User interface
Description In-article quick surveys or external surveys. Polling readers for opinion.
Author(s) Jon Robson, Joaquin Hernandez, Rob Moen, Bahodir Mansurov, Sam Smith, Adam Wight
Latest version 1.4.0
MediaWiki 1.26
License MIT License
Download
  • $wgQuickSurveysConfig
Translate the QuickSurveys extension if it is available at translatewiki.net
Check usage and version matrix.
Vagrant role quicksurveys
Issues Open tasks · Report a bug

The QuickSurveys extension displays in-article banners, through which users can be canvassed for their feedback.

DocumentationEdit

PrerequisitesEdit

QuickSurveys depends on EventLogging and won't work without it.

InstallationEdit

  • If using Vagrant , install with vagrant roles enable quicksurveys --provision
Manual installation
  • Download and place the file(s) in a directory called QuickSurveys in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'QuickSurveys' );
    
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

ConfigurationEdit

Here are configurations for the two major types of survey: an "internal survey" which displays a question and a set of possible answers in the article itself, and an "external survey" which links to another platform (e.g. Google Forms).

// A copy-and-pasteable example of an internal and external survey. The
// QuickSurveys extension includes these messages so you can copy and paste the
// following into your LocalSettings.php to see an example of each survey.
$wgQuickSurveysConfig = [
	// Example of an internal survey
	[
		// Survey name
		'name' => 'internal example survey',
		// Internal or external link survey?
		'type' => 'internal',
		// The respondent can choose one answer from a list.
		'layout' => 'single-answer',
		// Survey question message key
		'question' => 'ext-quicksurveys-example-internal-survey-question',
		// The message key of the description of the survey. Displayed immediately below the survey question.
		'description' => 'ext-quicksurveys-example-internal-survey-description',
		// Possible answer message keys for positive, neutral, and negative
		'answers' => [
			'ext-quicksurveys-example-internal-survey-answer-positive',
			'ext-quicksurveys-example-internal-survey-answer-neutral',
			'ext-quicksurveys-example-internal-survey-answer-negative'
		],
		// Label for the optional free form text answer
		'freeformTextLabel' => 'ext-quicksurveys-example-internal-survey-freeform-text-label',
		// Who is the survey for? All fields are optional.
		'audience' => [
			'minEdits' => 0,
			'maxEdits' => 500,
			'registrationStart' => '2018-01-01',
			'registrationEnd' => '2080-01-31',
			// You must have CentralNotice extension installed in order to limit audience by country
			'countries' => [ 'US', 'UK' ]
		],
		// Whether to shuffle the display of the answers
		'shuffleAnswersDisplay' => false,
		// Whether the survey is enabled
		'enabled' => true,
		// Percentage of users that will see the survey
		'coverage' => 0.5,
		// For each platform (desktop, mobile), which version of it is targeted
		'platforms' => [
			'desktop' => [ 'stable' ],
			'mobile' => [ 'stable' ]
		],
	],
	// Example of an external survey
	[
		'name' => 'external example survey',
		// Internal or external link survey
		'type' => 'external',
		// Survey question message key
		'question' => 'ext-quicksurveys-example-external-survey-question',
		// The i18n key of the description of the survey
		'description' => 'ext-quicksurveys-example-external-survey-description',
		// External link to the survey
		'link' => 'ext-quicksurveys-example-external-survey-link',
		// Parameter to add to external link
		'instanceTokenParameterName' => 'parameterName',
		// The i18n key of the privacy policy text
		'privacyPolicy' => 'ext-quicksurveys-example-external-survey-privacy-policy',
		'audience' => [
			// Show survey only to anonymous users
			'anons' => true,
		],
		// Whether the survey is enabled
		'enabled' => true,
		// Percentage of users that will see the survey
		'coverage' => 0.5,
		// For each platform (desktop, mobile), which version of it is targeted
		'platforms' => [
			'desktop' => [ 'stable' ],
			'mobile' => [ 'stable' ]
		]
	],
];

Defining an audienceEdit

It is possible to define audiences for a survey based edit count, whether a respondent is logged in, user registration date, and their country (based on IP).

The audience field is optional and can be omitted if you want the survey to show to everyone (as defined in coverage). You can also only include some of the parameters. For example, including just minEdits will target users who have at least that many edits with no maximum.

Note, the audience is not included in sampling, so for example if coverage is 0.5, 50% of all users will be bucketed for the survey, but only the users in that 50% that match the audience will actually see the survey.

All audience keys are additive.

We will accept several keys:

  • minEdits: the minimum number of edits a user should have
  • maxEdits: the maximum number of edits a user should have
  • anons: is the survey targeted to anons (true) or logged-in (false) only? If undefined, both groups will potentially be included.
  • registrationStart: if the survey is targeted by registration date, user had to join on or after this date. Date is in format YYYY-MM-DD
  • registrationEnd: if the survey is targeted by registration date, user had to join before or on this date. Date is in format YYYY-MM-DD
  • countries: a list of two letter country codes that are matched against window.Geo.country
  • pageIds: a list of article IDs, the survey can only be displayed on matching pages
		'audience': {
		    'minEdits': 2,
		    'maxEdits': 5,
		    'registrationStart': '2018-01-01',
		    'registrationEnd': '2018-01-31',
			'pageIds': [ 1234, 9876 ],
		    'countries': [ 'US', 'UK' ]
		},

Survey layoutEdit

The following configuration fields control how the survey will be displayed:

  • type: external - The survey is hosted on an external website, all we show is a link.
     
    External survey
  • layout: single-answer - Choices are each presented as a button. Clicking a choice will immediately submit and dismiss the survey, unless a freeform text input is enabled.
     
    Single-answer survey
  • layout: multiple-answer - Choices are each presented as a checkbox. Multiple choices can be selected. A freeform text input will not be provided.
     
    Multiple-answer survey
  • freeformTextLabel - The respondent is prompted to enter freeform text, in addition to an optional choice of answer.
     
    Survey with freeform text input enabled
  • shuffleAnswersDisplay - The answers will be randomized and displayed in a different order for each respondent. This helps average out a response bias caused by the order of answers. Defaults to true.
  • embedElementId - When this field is present, the survey can only be injected into a page with a DOM element matching the configured value by ID. For example, a survey with embedElementId: "survey-embed-point" will be displayed on a page with HTML <div id="survey-embed-point"></div>, immediately after that element.
     
    Survey embedded at a specific location

Adding message keysEdit

Messages can be defined as part of an extension e.g. WikimediaMessages or by wiki page. For example the message "ext-quicksurveys-example-internal-survey-answer-positive" can be defined by editing the wiki page MediaWiki:ext-quicksurveys-example-internal-survey-answer-positive

For editing messages ensure you have the right permissions. You will need edit-interface right.

How to load a specific surveyEdit

You can bypass the sampling and load a survey using one of the methods below. Please note that the survey you want to load needs to be enabled and passed to the front end. See the "Notes and Gotchas" section if you are having trouble seeing a survey.

  • To load a random survey append ?quicksurvey=true to the URL;
  • To load an internal survey whose name is 'internal example survey' append ?quicksurvey=internal-survey-internal example survey to the URL;
  • To load an external survey whose name is 'external example survey' append ?quicksurvey=external-survey-external example survey to the URL.

Note: The quicksurvey parameter is not the literal survey name. It's the type and survey name. The leading internal-survey- or external-survey- is stripped when looking up the survey name in the configuration. E.g., ?quicksurvey=internal-survey-drink-survey picks the survey named drink-survey not internal-survey-drink-survey.

Developer guideEdit

Rules for displaying a surveyEdit

Much of this logic seems to reside on the client.

mw.config.get( 'wgEnabledQuickSurveys' )

tells you what surveys are available.

ResultsEdit

The initial impressions and responses are recorded in EventLogging. Initial impressions are in the QuickSurveyInitiation schema and responses are in QuickSurveysResponses. The surveyCodeName field in both schemas corresponds to the survey's configured name.

Notes and GotchasEdit

  • window.Geo is provided by CentralNotice. To avoid setting up an extension run JSON.stringify( window.Geo ) in production and add window.Geo = <data>; to your code.

Note that a survey won't show up when:

  • on the Main Page;
  • on non-article page;
  • on non-existent article page. Be careful when using the MobileFrontend content provider!;
  • on skin Minerva when the beta opt in panel is shown;
  • (Broken: if a survey is an external one and points to non-https location. TODO: Pending task T255291.)