Extension:OpenSearchXml

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual
Crystal Clear action run.png
OpenSearchXml

Release status: stable

Implementation Search, API
Description OpenSearch XML interface provides for text extracts
Author(s) Brion Vibber (Brion VIBBERtalk)
MediaWiki 1.19+
PHP 5.3+
License GPLv2 or Later
Download
Parameters
  • $wgOpenSearchAdvertiseXml
  • $wgOpenSearchDescriptionLength
Hooks used
OpenSearchUrls

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

Check usage and version matrix; code metrics
Bugs: list open list all report

The OpenSearchXml extension adds the possibility to have search suggestions in OpenSearch XML format. This extension allows the search box to "suggest" search terms as searcher types in the query.

Installation[edit | edit source]

  • Download and extract the file(s) in a directory called OpenSearchXml in your extensions/ folder. If you're a developer and this extension is in a Git repository, then instead you should clone the repository using:
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/OpenSearchXml.git
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/OpenSearchXml/OpenSearchXml.php";
$wgEnableMWSuggest = true; #Not needed if using MediaWiki 1.20+
  • Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.