MediaWiki extensions manual
SpellingApi
Release status: beta
Implementation API
Description Provides an API for spell-checking
Author(s) Amir E. Aharoni (Amire80talk)
Latest version 0.3.0 (2018-02-12)
MediaWiki 1.20+
Database changes No
License GNU General Public License 2.0 or later
Download
Quarterly downloads 2 (Ranked 168th)
Translate the SpellingApi extension if it is available at translatewiki.net

The SpellingApi extension adds an API module for checking the spelling of texts. It uses the PHP pspell library, so it must be installed on the server.

The current version is just a simple proof of concept.

Download

The extension can be retrieved directly from Git [?]:

  • Browse code
  • Some extensions have tags for stable releases.
  • Each branch is associated with a past MediaWiki release. There is also a "master" branch containing the latest alpha version (might require an alpha version of MediaWiki).
    • Browse branches
    • Select a branch name
    • Click "Continue"

Extract the snapshot and place it in the extensions/SpellingApi/ 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:

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

Installation

  • Download and place the file(s) in a directory called SpellingApi in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php file: 
    wfLoadExtension( 'SpellingApi' );
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension(). If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of wfLoadExtension( 'SpellingApi' );, you need to use:

require_once "$IP/extensions/SpellingApi/SpellingApi.php";
This article is issued from Mediawiki. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.