Extension:EditSimilar

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
EditSimilar

Release status:Extension status stable

ImplementationTemplate:Extension#type Notify
DescriptionTemplate:Extension#description Encourages users to edit articles similar (by categories) to the one they just edited.
Author(s)Template:Extension#username Bartek Łapiński and Łukasz 'TOR' Garczewski
Latest versionTemplate:Extension#version 1.23 (2014-10-03)
MediaWikiTemplate:Extension#mediawiki 1.23+
LicenseTemplate:Extension#license GNU General Public License 2.0 or later
Download
ParametersTemplate:Extension#parameters

$wgEditSimilarMaxResultsPool
$wgEditSimilarMaxResultsToDisplay
$wgEditSimilarCounterValue
$wgEditSimilarMarker
$wgEditSimilarAlwaysShowThanks

Hooks usedTemplate:Extension#hook
PageContentSaveCompleteManual:Hooks/PageContentSaveComplete
OutputPageBeforeHTMLManual:Hooks/OutputPageBeforeHTML
GetPreferencesManual:Hooks/GetPreferences

Translate the EditSimilar extension if it is available at translatewiki.net

Check usage and version matrix.

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 Wikia.

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).

Requirements[edit]

The following requirements must be satisfied for the EditSimilar extension to work.

  • MediaWiki 1.23 or newer

Licensing[edit]

The extension is available under the GNU General Public License 2.0 or later.

The software is provided as-is. Updates will be made according to where critical vulnerabilities are discovered.

Installation[edit]

  • Download and place the file(s) in a directory called EditSimilar in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    require_once "$IP/extensions/EditSimilar/EditSimilar.php";
    
  • 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.

  • YesY 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)