MediaWiki extensions manual

TitleKey Release status: stableCategory:Stable extensions
Implementation	SearchCategory:Search extensions
Description	Provides a case-insensitive page title prefix search
Author(s)	Brooke Vibbertalk
Latest version	continuous updates
MediaWiki	1.25+Category:Extensions with manual MediaWiki version
Database changes	Yes
Tables	titlekey
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Browse repository (GitHub) Gerrit code review Git commit log Download source tarball Category:Extensions in Wikimedia version control README
Hooks used LoadExtensionSchemaUpdates Category:LoadExtensionSchemaUpdates extensions PageDeleteComplete Category:PageDeleteComplete extensions PageMoveCompleting Category:PageMoveCompleting extensions PageSaveComplete Category:PageSaveComplete extensions PageUndeleteComplete Category:PageUndeleteComplete extensions
Quarterly downloads	53 (Ranked 66th)
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 that 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.

Installation

• 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' );
  // For MW 1.43.0 and above, no further configuration is needed.
  
  // For MW 1.42.x (use SearchEngineMySQL, SearchEnginePostgres, or SearchEngineSqlite depending on your $wgDBtype)
  $wgSearchType = MediaWiki\Extension\TitleKey\SearchEngineMySQL::class;
  
  // For MW 1.39.x to 1.41.x
  $wgSearchType = MediaWiki\Extension\TitleKey\SearchEngine::class;
  

• 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

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.php RebuildTitleKeys

$ php path/to/mediawiki/extensions/TitleKey/maintenance/rebuildTitleKeys.php

This extension is included in the following wiki farms/hosts and/or packages: BlueSpice Category:Extensions included in BlueSpice Miraheze Category:Extensions included in Miraheze ProWikiCategory:Extensions included in ProWiki WikiForgeCategory:Extensions included in WikiForge This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm.