Extension:ArticleFeedbackv5

MediaWiki extensions manual

Article Feedback v5 Release status: stable
Implementation	Special page
Description	Encourage users to contribute by allowing them to verbally assess an article.
Author(s)	Greg Chiasson Reha Sterbin Sam Reed Roan Kattouw Trevor Parscal Brandon Harris Adam Miller Nimish Gautam Arthur Richards Timo Tijhof Ryan Kaldari Elizabeth M Smith Michael Jackson Matthias Mullie Jack Phoenix
Latest version	5.6.0
MediaWiki	>= 1.39.0
Database changes	Yes
Composer	mediawiki/article-feedbackv5
Tables	aft_feedback
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (Phabricator · GitHub) commit history repository contributors (GitHub) code review
Example	Brickipedia
Parameters $wgArticleFeedbackv5DefaultSorts $wgArticleFeedbackv5BackendClass $wgArticleFeedbackv5Debug $wgArticleFeedbackv5HideAbuseThreshold $wgArticleFeedbackv5Watchlist $wgArticleFeedbackv5AutoArchiveEnabled $wgArticleFeedbackv5RatingLifetime $wgArticleFeedbackv5AbuseFiltering $wgArticleFeedbackv5LinkBuckets $wgArticleFeedbackv5CTABuckets $wgArticleFeedbackv5TalkPageLink $wgArticleFeedbackv5OversightEmailName $wgArticleFeedbackv5AbusiveThreshold $wgArticleFeedbackv5ArticlePageLink $wgArticleFeedbackv5OversightEmailHelp $wgArticleFeedbackv5BlacklistCategories $wgArticleFeedbackv5Categories $wgArticleFeedbackv5MaxActivityNoteLength $wgArticleFeedbackv5MaxCommentLength $wgArticleFeedbackv5LotteryOdds $wgArticleFeedbackv5SurveyUrls $wgArticleFeedbackv5EnableProtection $wgArticleFeedbackv5Permissions $wgArticleFeedbackv5ThrottleThresholdPostsPerHour $wgArticleFeedbackv5DisplayBuckets $wgArticleFeedbackv5WatchlistLink $wgArticleFeedbackv5AbuseFilterGroup $wgArticleFeedbackv5LearnToEdit $wgArticleFeedbackv5Cluster $wgArticleFeedbackv5AutoHelp $wgArticleFeedbackv5OversightEmails $wgArticleFeedbackv5AutoArchiveTtl $wgArticleFeedbackv5DefaultFilters $wgArticleFeedbackv5RelevanceScoring
Added rights aft-reader aft-member aft-editor aft-monitor aft-administrator aft-oversighter
Hooks used AbuseFilterCustomActions BeforeCreateEchoEvent BeforePageDisplay ContribsPager::reallyDoQuery ContributionsLineEnding EchoGetBundleRules EchoGetDefaultNotifiedUsers EditPage::showEditForm:fields GetPreferences LoadExtensionSchemaUpdates MakeGlobalVariablesScript ProtectionForm::buildForm ProtectionForm::save ProtectionForm::showLogExtract ResourceLoaderGetConfigVars UserGetReservedNames UserLoginComplete
Quarterly downloads	14 (Ranked 123rd)
Translate the ArticleFeedbackv5 extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

The Article Feedback extension (aka Article Feedback Tool, Version 5) shows readers a form at the bottom of the page, encouraging them to give public feedback on the article they read. This feedback can be viewed and actioned on wiki and used by editors to improve the articles.

The extension was initially developed as a Wikimedia Foundation project designed to engage Wikimedia readers in assessing article quality, one of the five priorities defined in the strategic plan. No longer developed by WMF, ArticleFeedbackv5 remains stable and supported by ShoutWiki for Brickipedia, and it has been so since September 2016 (T144677).

Reusers of the extension should be aware of task T56197 and task T60956.

Warning:

This extension is currently incompatible with temporary accounts. Temporary accounts can be disabled with $wgAutoCreateTempUser['enabled'] = false; in your LocalSettings.php.

Installation

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

  wfLoadExtension( 'ArticleFeedbackv5' );
  

• Run the update script which will automatically create the necessary database tables that this extension needs.
• Configure as required.
•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

If your wiki has a lot of traffic, the AbuseFilter extension is recommended to manage abusive feedback.

Configuration

$wgArticleFeedbackv5Categories

An array of category titles (using '_'s instead of spaces). Pages in any of these categories will have the rating widget shown (regardless of the $wgArticleFeedbackv5LotteryOdds described elsewhere). If empty (the default), the extension is effectively disabled. e.g.:

$wgArticleFeedbackv5Categories = [ 'Foo_bar', 'Baz' ];

$wgArticleFeedbackv5BlacklistCategories

Which categories the pages must not belong to have the widget added (with _ in text). e.g.:

$wgArticleFeedbackv5BlacklistCategories = [ 'Baz' ];

$wgArticleFeedbackv5Namespaces

Only enable the widget in these namespaces (regardless of the page category). Defaults to $wgContentNamespaces (defaults to [ NS_MAIN ] ). e.g.:

$wgArticleFeedbackv5Namespaces = [ NS_MAIN, NS_HELP, NS_PROJECT ];

$wgArticleFeedbackv5LotteryOdds

The percentage of article AFT should be enabled. Even when a lottery is set for a certain namespace, AFT will not show up unless that namespace is added to $wgArticleFeedbackv5Namespaces. This can be set as an integer as a site-wide percentage or as a key-value array for a per-namespace percentage. e.g.:

// enable site-wide on 100% on all namespaces defined in $wgArticleFeedbackv5Namespaces
$wgArticleFeedbackv5LotteryOdds = 100;

// enable 100% on the main namespace & 50% on the help namespace (assuming both are also defined in $wgArticleFeedbackv5Namespaces)
$wgArticleFeedbackv5LotteryOdds = [ NS_MAIN => 100, NS_HELP => 50 ];

Technical: AFT will be enabled for all articles with an ID ending on (1000 - (odds * 10)) and above. For example, when setting odds at 15%, all articles whose ID ends in 850-999 will have AFT enabled.

$wgArticleFeedbackv5TalkPageLink

Defines whether or not there should be a link to the corresponding feedback on the page's talk page. e.g.:

$wgArticleFeedbackv5TalkPageLink = true;

$wgArticleFeedbackv5WatchlistLink

Defines whether or not there should be a link to the watchlisted feedback on the watchlist page. e.g.:

$wgArticleFeedbackv5WatchlistLink = true;

Note: The watchlist feature does not scale well. You may want to disable it on large wikis.

$wgArticleFeedbackv5DisplayBuckets

This defines which form should be displayed and at what percentage. Note that support for some forms (2, 3, 5) has been discontinued, as they no longer fit the technical architecture the rest was built upon.

$wgArticleFeedbackv5DisplayBuckets = [
	'buckets' => [
		'0' => 0, // display nothing
		'1' => 0, // display 1-step feedback form
//		'2' => 0, // abandoned
//		'3' => 0, // abandoned
		'4' => 0, // display encouragement to edit page
//		'5' => 0, // abandoned
		'6' => 100, // display 2-step feedback form
	],
	'version' => 6,
	'expires' => 30,
]);

$wgArticleFeedbackv5LinkBuckets

This defines which links should be displayed and at what percentage.

$wgArticleFeedbackv5LinkBuckets = [
	'buckets' => [
		'X' => 100,
		'A' => 0,
		'B' => 0,
		'C' => 0,
		'D' => 0,
		'E' => 0,
		'F' => 0,
		'G' => 0,
		'H' => 0,
	],
	'version' => 5,
	'expires' => 30,
];

$wgArticleFeedbackv5CTABuckets

This defines which CTAs should be displayed and at what percentage.

$wgArticleFeedbackv5CTABuckets = [
	'buckets' => [
		'0' => 0, // display nothing
		'1' => 40, // display "Enticement to edit"
		'2' => 10, // display "Learn more"
		'3' => 0, // display "Take a survey"
		'4' => 20, // display "Sign up or login"
		'5' => 20, // display "View feedback"
		'6' => 10, // display "Visit Teahouse"
	],
	'version' => 4,
	'expires' => 0,
];

$wgArticleFeedbackv5MaxCommentLength

Restrict comment length to an arbitrary number of characters. It defaults to zero for no check. e.g.:

$wgArticleFeedbackv5MaxCommentLength = 400;

Permissions

AFTv5 introduces a new set of permissions to define users' access roles. These are mapped to the following already existing groups by default, so make sure these are configured on your setup (or bind the AFT permissions to the appropriate groups in your setup):

• aft-reader: *, user, confirmed, autoconfirmed, rollbacker, reviewer, sysop, oversight
• aft-member: user, confirmed, autoconfirmed, rollbacker, reviewer, sysop, oversight
• aft-editor: confirmed, autoconfirmed, rollbacker, reviewer, sysop, oversight
• aft-monitor: rollbacker, reviewer, sysop, oversight
• aft-administrator: sysop, oversight
• aft-oversighter: oversight

See also

• Technical design