Extension:OpenSearchXml

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

Release status: beta

Implementation Search, API
Description OpenSearch XML interface provides for text extracts
Author(s) Brion Vibber (Brion VIBBERtalk)
License GPLv2 or Later
Download
Parameters

$wgOpenSearchAdvertiseXml

Hooks used
OpenSearchUrls
Check usage and version matrix
Bugs: list open list all report

OpenSearchXml 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 query.

Download [edit]

You can download the extension directly from the MediaWiki source code repository (browse code). You can get:

One of the extensions tags

Not all extensions have tags. Some extensions have tags for each release, in which case those tags have the same stability as the release. To download a tag

  • Go to the tags list
  • Click the name of the tag you want to download
  • Click "snapshot"
The latest version of one of the extensions branches

Each extension has a master branch containing the latest code (might be unstable). Extensions can have further branches as well.

  • Go to the branches list
  • Click the branch name
  • Click "snapshot"
A snapshot made during the release of a MediaWiki version.

This might be unstable and is not guaranteed to work with the associated MediaWiki version.

After you've got the code, save it into the extensions/OpenSearchXml directory of your wiki.

If you are familiar with git and have shell access to your server, you can obtain the extension, with all its tags and branches, as follows:

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

Installation [edit]

  1. Add
    require_once( "$IP/extensions/OpenSearchXml/OpenSearchXml.php" );
    to LocalSettings.php
  2. The extension should be now active.
  3. Don't forget to set $wgEnableMWSuggest to true in your LocalSettings.php file.