Issue tracker: #cirrussearch

Extension:WikibaseCirrusSearch

From Linux Web Expert

MediaWiki extensions manual
File:OOjs UI icon advanced-invert.svg
WikibaseCirrusSearch
Release status: stable
Implementation Search, API
Description Implements searching for Wikibase using ElasticSearch
Author(s) Stas Malyshev
Latest version 0.0.1 (continuous updates)
Compatibility policy Master maintains backward compatibility.
MediaWiki 1.33+
PHP 7.0+
Composer wikibase/cirrussearch
License GNU General Public License 2.0 or later
Download
<translate> Download extension</translate>
<translate> Git</translate> [?]:

README
Help Help:Extension:WikibaseCirrusSearch
Parameters
  • $wgDefaultPrefixRescoreProfile
  • $wgUseCirrus
  • $wgPrefixSearchProfiles
  • $wgFulltextSearchProfiles
  • $wgDefaultFulltextRescoreProfile
  • $wgLanguageSelectorStatementBoost
  • $wgFulltextSearchProfile
  • $wgStatementBoost
  • $wgRescoreProfiles
  • $wgLanguageSelectorRescoreFunctionChains
  • $wgLanguageSelectorPrefixSearchProfile
  • $wgUseStemming
  • $wgRescoreFunctionChains
  • $wgLanguageSelectorRescoreProfile
  • $wgLicenseMapping
  • $wgPrefixSearchProfile
Hooks used
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 WikibaseCirrusSearch extension if it is available at translatewiki.net
Vagrant role wikibasecirrussearch
Issues Open tasks · Report a bug

The WikibaseCirrusSearch extension provides ElasticSearch functionality, as supported by CirrusSearch extension, to Wikibase Repository extension. It requires both CirrusSearch and Wikibase Repository extensions to be installed.

Installation

  • <translate> [[<tvar name=2>Special:ExtensionDistributor/WikibaseCirrusSearch</tvar>|Download]] and move the extracted <tvar name=name>WikibaseCirrusSearch</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/WikibaseCirrusSearch
  • <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate> 
    wfLoadExtension( 'WikibaseCirrusSearch' );
    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

The configuration options of WikibaseCirrusSearch are documented at the docs/config.wiki file.

Following configuration options are supported (all variables are prefixed with wgWBCS in globals):

UseCirrus
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.
PrefixSearchProfile
name of the label scoring profile to use for prefix search. The profile should be defined like examples in config/EntityPrefixSearchProfiles.php.
PrefixSearchProfiles
Loaded from config/EntityPrefixSearchProfiles.php, does not need to be defined manually.
DefaultPrefixRescoreProfile
name of the rescoring profile to use for prefix search. The profile should be defined in config/ElasticSearchRescoreProfiles.php.
FulltextSearchProfile
name of the search profile to use for fulltext search. The profile should be defined like examples in config/EntitySearchProfiles.php.
FulltextSearchProfiles
search profiles to use for fulltext search.
DefaultFulltextRescoreProfile
name of the rescoring profile to use for fulltext search. The profile should be defined in config/ElasticSearchRescoreProfiles.php.
RescoreProfiles
Loaded from config/ElasticSearchRescoreProfiles.php, does not have to be defined manually.
StatementBoost
Configuration to boost or deboost certain statement values.
UseStemming
Configuration to use stemming analyzer for descriptions in certain languages. Array of two fields: index – use it for indexing, query – use main text field for querying.

See Also

Retrieved from "https://www.linuxwebexpert.com/wiki/index.php?title=Extension:WikibaseCirrusSearch&oldid=27815"