Extension:TitleKey

MediaWiki extensions manual
TitleKey
Release status: stable
Implementation Search
Description Provides a case-insensitive page title prefix search
Author(s) Brooke Vibbertalk
Latest version continuous updates
MediaWiki 1.25+
Database changes Yes
Tables titlekey
License GNU General Public License 2.0 or later
Download
README
Quarterly downloads 58 (Ranked 80th)
Translate the TitleKey extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

The TitleKey extension provides a case-insensitive page title prefix search. It uses a separate table for the keys, so it can be deployed without an expensive rebuild of core tables and uninstalled later in preference for a different search extension such as CirrusSearch .

For the average site administrator, the benefit of this extension is that it allows search suggestions (e.g., from Opensearch API) to be case-insensitive.

This extension provides no benefit if you are using CirrusSearch .

Installation

edit
  • Download and move the extracted TitleKey folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/TitleKey
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'TitleKey' );
    $wgSearchType = MediaWiki\Extension\TitleKey\SearchEngine::class; // starting MW 1.41 and later
    
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Maintenance

edit

The RebuildTitleKeys maintenance script can be used at any time to rebuild the title index (this requires command-line access):

$ path/to/mediawiki/maintenance/run RebuildTitleKeys
Or, for MediaWiki prior to 1.40:
$ php path/to/mediawiki/extensions/TitleKey/maintenance/rebuildTitleKeys.php