MediaWiki extensions manual

ReconciliationAPI Release status: stableCategory:Stable extensions
Implementation	API Category:API extensions, ContentHandler Category:ContentHandler extensions
Description	Enables API modules for entity reconciliation and autocompletion
Author(s)	DG
Latest version	0.1
MediaWiki	1.39+Category:Extensions with manual MediaWiki version
License	No license specified
Download	GitHub: project page git repository URL [help ] commit history Note: No localisation updates are provided by translatewiki.net . Category:Extensions in GitHub version control
Namespace NS_RECON (NS_RECON_TALK)

The Reconciliation API extension lets you set up API modules for entity reconciliation and autocompletion using either 'MediaWiki core' or Semantic MediaWiki. The services for entity reconciliation follow the W3C specifications of the Reconciliation API (v0.2) and in so doing, can help you open up your wiki's data for linking, discovery and collaboration, for instance by facilitating connections to tools like OpenRefine. Using this framework as a basis, it also allows you to set up and finetune API endpoints for autocompletion, whether for external or wiki internal uses.

The extension is developed and maintained for CODECS, a Semantic MediaWiki-driven wiki for Celtic studies.

Features in a nutshell

• The current focus is on two ways of setting up your data: MediaWiki core, using native methods only, and Semantic MediaWiki (tested with v4.1.3 only)
• Special handling for matching with Full-Text Search
• About five Action API modules (including metadata for diagnostics or debugging)
• Many configuration options available
• Dedicated API profiles managed through JSON schemas in the wiki (namespace: Recon). Comes with simple JSON validation
• A parser function (#recon-search) for creating typeahead widgets
• Redirect service through a special page in the wiki. Intended for handling situations in which pages cannot be accessed directly or require an additional check.

Installation

• Download and place the file(s) in a directory called ReconciliationAPI in your extensions/ folder.
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'ReconciliationAPI' );
  

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

Configuration and usage

After the extension has been installed successfully, head over the guide available from Special:ReconciliationAPI on your wiki. It includes information about configuration settings, JSON schemas and API modules.

Extensions

It is recommended to use this extension with the following extensions:

• Semantic MediaWiki - although a 'core MediaWiki' mode is supported, which makes use of native MediaWiki functionality, the extension was specifically created for wikis using SMW
• CodeEditor - for editing JSON schemas

Support is available for:

• Page Forms - the recon-suggest-entity API module can be used with the 'values from url' form field
• PageImages
• Admin Links

Screenshot