Extension:TitleKey

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.svg
TitleKey

Release status:Extension status stable

ImplementationTemplate:Extension#type Search
DescriptionTemplate:Extension#description Provides a title prefix search suggestion backend
Author(s)Template:Extension#username Brion Vibber (Brion VIBBERtalk)
Latest versionTemplate:Extension#version continuous updates
MediaWikiTemplate:Extension#mediawiki 1.25+
Database changesTemplate:Extension#needs-updatephp Yes
TablesTemplate:Extension#table1 titlekeyExtension:TitleKey/titlekey table
LicenseTemplate:Extension#license GNU General Public License 2.0 or later
Download
README
Hooks usedTemplate:Extension#hook
ArticleDeleteManual:Hooks/ArticleDelete
ArticleDeleteCompleteManual:Hooks/ArticleDeleteComplete
ArticleInsertCompleteManual:Hooks/ArticleInsertComplete
ArticleUndeleteManual:Hooks/ArticleUndelete
TitleMoveCompleteManual:Hooks/TitleMoveComplete
ParserTestTablesManual:Hooks/ParserTestTables
LoadExtensionSchemaUpdatesManual:Hooks/LoadExtensionSchemaUpdates
PrefixSearchBackendManual:Hooks/PrefixSearchBackend
SearchGetNearMatchManual:Hooks/SearchGetNearMatch

Translate the TitleKey extension if it is available at translatewiki.net

Check usage and version matrix.

IssuesPhabricator

Open tasks · Report a bug

The TitleKey extension provides a case-insensitive 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 place the file(s) in a directory called TitleKey in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'TitleKey' );
    
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • Run the "rebuildTitleKeys.php" script (this requires command-line access):
php extensions/TitleKey/rebuildTitleKeys.php
  • YesY Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.27 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension() If you need to install this extension on these earlier versions (MediaWiki 1.27 and earlier), instead of wfLoadExtension( 'TitleKey' );, you need to use:

require_once "$IP/extensions/TitleKey/TitleKey.php";
Other languages:Project:Language policy English  • français