Extension:WikibaseLexemeCirrusSearch

From Linux Web Expert

MediaWiki extensions manual
WikibaseLexemeCirrusSearch
Release status: stable
Implementation Search, API
Description Implements searching for Wikibase Lexeme space using ElasticSearch
Author(s) Stas Malyshev
Latest version 0.1.0 (continuous updates)
Compatibility policy Master maintains backward compatibility.
MediaWiki 1.33+
PHP 7.0+
Database changes No
Composer wikibase/lexeme-cirrusssearch
License GNU General Public License 2.0 or later
Download
README

  • $wgLexemeUseCirrus
  • $wgLexemePrefixSearchProfile
  • $wgLexemePrefixSearchProfiles
  • $wgLexemePrefixRescoreProfile
  • $wgLexemeFulltextRescoreProfile
  • $wgLexemeRescoreFunctions
Quarterly downloads Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').
Public wikis using Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').
Translate the WikibaseLexemeCirrusSearch extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

The WikibaseLexemeCirrusSearch extension provides ElasticSearch functionality, as supported by CirrusSearch extension, to WikibaseLexeme extension. It requires both CirrusSearch and WikibaseLexeme extensions to be installed.

Installation

  • <translate> [[<tvar name=2>Special:ExtensionDistributor/WikibaseLexemeCirrusSearch</tvar>|Download]] and move the extracted <tvar name=name>WikibaseLexemeCirrusSearch</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
    <translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate>cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/WikibaseLexemeCirrusSearch
  • <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>
    wfLoadExtension( 'WikibaseLexemeCirrusSearch' );
    
  • Configure as required.
  • File:OOjs UI icon check-constructive.svg <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

Configuration

Following configuration options are supported:

$wgLexemeUseCirrus
boolean|null, whether we should use search functionality provided by this extension. If set to null, CirrusSearch is not used unless the request has useCirrus=1. Note: The default for this value is false, to enable search functionality it should be set to true in the configuration.
$wgLexemePrefixSearchProfile
name of the label scoring profile to use for prefix search. The profile should be defined like examples in config/LexemePrefixSearchProfiles.php.
$wgLexemePrefixSearchProfiles
Loaded from config/LexemePrefixSearchProfiles.php, does not need to be defined manually.
$wgLexemePrefixRescoreProfile
name of the rescoring profile to use for prefix search. The profile should be defined in config/LexemePrefixSearchProfiles.php.
$wgLexemeFulltextRescoreProfile
name of the search profile to use for fulltext search. The profile should be defined like examples in config/LexemeRescoreProfiles.php.
$wgLexemeRescoreFunctions
Loaded from config/LexemeRescoreFunctions.php.php, does not have to be defined manually.

See Also