Issue tracker: #ArticleFeedbackv5

Extension:ArticleFeedbackv5

From Linux Web Expert

MediaWiki extensions manual
File:OOjs UI icon advanced-invert.svg
Article Feedback v5
Release status: stable
File:AFT5-Feedback-Form-Option-1-Launch-Screenshot.png
Implementation Special page
Description Encourage users to contribute by allowing them to verbally assess an article.
Author(s)
Latest version 5.6.0
MediaWiki >= 1.38.0
Database changes Yes
Composer mediawiki/article-feedbackv5
Tables aft_feedback
License GNU General Public License 2.0 or later
Download
<translate> Download extension</translate>
<translate> Git</translate> [?]:
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
Quarterly downloads Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').
Public wikis using Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').
Translate the ArticleFeedbackv5 extension if it is available at translatewiki.net
Issues Open tasks · Report a bug
See Article feedback/Version 5 for more information.

The Article Feedback extension (aka Article Feedback Tool, Version 5) shows a form to readers 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 originally developed as a Wikimedia Foundation project designed to engage Wikimedia readers in the assessment of 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 <translate> task <tvar name=1>T56197</tvar></translate> and <translate> task <tvar name=1>T60956</tvar></translate>.

Download

<translate> The extension can be retrieved directly from Git</translate> [?]:

  • <translate> Browse code</translate>
  • <translate> Some extensions have tags for stable releases.</translate>
  • <translate> Each branch is associated with a past MediaWiki release.</translate> <translate> There is also a "master" branch containing the latest alpha version (might require an alpha version of MediaWiki).</translate>

<translate> Extract the snapshot and place it in the <tvar name=name>extensions/ArticleFeedbackv5/</tvar> directory of your MediaWiki installation.

If you are familiar with Git and have shell access to your server, you can also obtain the extension as follows: </translate>

cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ArticleFeedbackv5.git

Installation

  • <translate> [[<tvar name=2>Special:ExtensionDistributor/ArticleFeedbackv5</tvar>|Download]] and move the extracted <tvar name=name>ArticleFeedbackv5</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
    <translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate>cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ArticleFeedbackv5
  • <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate> 
    wfLoadExtension( 'ArticleFeedbackv5' );
  • <translate> Run the [[<tvar name=update>Special:MyLanguage/Manual:Update.php</tvar>|update script]] which will automatically create the necessary database tables that this extension needs.</translate>
  • File:OOjs UI icon check-constructive.svg <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>
  • If your wiki has a lot of traffic, Extension:AbuseFilter 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 = array( 'Foo_bar', 'Baz' );

$wgArticleFeedbackv5BlacklistCategories

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

$wgArticleFeedbackv5BlacklistCategories = array( 'Baz' );

$wgArticleFeedbackv5Namespaces

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

$wgArticleFeedbackv5Namespaces = array( NS_MAIN, NS_HELP, NS_PROJECT );

$wgArticleFeedbackv5LotteryOdds

Percentage of article AFT should be enabled on. Note that even when a lottery is set for a certain namespace, AFT will not show up unless that namespace is also added to $wgArticleFeedbackv5Namespaces. This can be set either as 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 main namespace & 50% on help namespace (assuming both are also defined in $wgArticleFeedbackv5Namespaces)
$wgArticleFeedbackv5LotteryOdds = array( NS_MAIN => 100, NS_HELP => 50 );

Technical: all articles with an ID ending on (1000 - (odds * 10)) and above, will get AFT enabled. E.g. 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 this feature 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 completely, as they no longer fit the technical architecture the rest was built upon. 

$wgArticleFeedbackv5DisplayBuckets = array(
	'buckets' => array(
		'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 = array(
	'buckets' => array(
		'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 = array(
	'buckets' => array(
		'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. 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

Feedback

Software bugs can feature requests can be submitted via Wikimedia's Phabricator.

See also

Retrieved from "https://www.linuxwebexpert.com/wiki/index.php?title=Extension:ArticleFeedbackv5&oldid=10462"