Extension:EditSimilar

From mediawiki.org
MediaWiki extensions manual
EditSimilar
Release status: stable
Implementation Notify
Description Encourages users to edit articles similar (by categories) to the one they just edited.
Author(s) Bartek Łapiński and Łukasz 'TOR' Garczewski
Latest version 1.23 (2014-10-03)
MediaWiki 1.23+
License GNU General Public License 2.0 or later
Download
  • $wgEditSimilarCounterValue
  • $wgEditSimilarMaxResultsToDisplay
  • $wgEditSimilarMaxResultsPool
  • $wgEditSimilarAlwaysShowThanks
Quarterly downloads 3 (Ranked 153rd)
Translate the EditSimilar extension if it is available at translatewiki.net

EditSimilar is an extension that suggests similar articles that need attention upon save. It was originally written by Bartek Łapiński and Łukasz Garczewski for Fandom.

It finds and suggests another article that may need attention or improvement when a user saves an edit. It is designed to help users decide what to do next, and boost the number of edits on a wiki.

The suggestions are only displayed when saving in the main (article) namespace, and will not show up on talk pages, project pages and other namespaces.

By default, the message is set to appear after every five qualifying article edits. The frequency of messages can be adjusted by a global variable (see the Configuration section below).

Installation[edit]

  • Download and move the extracted EditSimilar 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/EditSimilar
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'EditSimilar' );
    
  • You also have to perform some basic setup. Edit the MediaWiki:EditSimilar-Categories article and populate it with category names you designate as "stubs". For example:
* Stub Category 1
* Stub Category 2
* Stub Category 3 

Those will be needed to determine relevant or suggested articles.

  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.


Configuration[edit]

Apart from editing MediaWiki:EditSimilar-Categories page, you can set additional parameters:

  • $wgEditSimilarMaxResultsPool - this is the maximum pool of results to choose randomly from (defaults to 50)
  • $wgEditSimilarMaxResultsToDisplay - this is the maximum number of chosen results to display (defaults to 3)
  • $wgEditSimilarCounterValue - this specifies per which number of edits show the results' message (defaults to 1, which means that every time results are found the message is shown)
  • $wgEditSimilarAlwaysShowThanks - whether to thank for an edit even on no results (unset by default, set to true if you want to have that)