Extension:TitleKey: Difference between revisions

**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	Download extension ; Git [?]: Download Git master; browse repository (GitHub); commit history; repository contributors (GitHub); code review; ; README
	Hooks used LoadExtensionSchemaUpdates; PageDeleteComplete; PageMoveCompleting; PageSaveComplete; PageUndeleteComplete;
Quarterly downloads	65 (Ranked 78th)
	Translate the TitleKey extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

Browse history interactively

← Older edit

Content deleted Content added

VisualWikitext

Inline

Latest revision as of 07:37, 2 December 2024

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.

This extension provides no benefit if you are using CirrusSearch.

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 RebuildTitleKeys

Or, for MediaWiki before 1.40:

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

This extension is included in the following wiki farms/hosts and/or packages:

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.

@@ Line 6: / Line 6: @@
 |version = <translate><!--T:1--> continuous updates</translate>
 |description = <translate><!--T:2--> Provides a case-insensitive page title prefix search</translate>
-|username = Brion VIBBER
+|username = Brooke Vibber
-|author    = Brion Vibber
 |download  = {{WikimediaDownload|TitleKey}}
 |changelog =
@@ Line 14: / Line 13: @@
 |table1 = titlekey
 }}
+<translate><!--T:3--> The '''TitleKey''' extension provides a case-insensitive page title prefix search.</translate> <translate><!--T:4--> 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 <tvar name=1>{{Ll|Extension:CirrusSearch|nsp=0}}</tvar>.</translate>
-<translate>
-<!--T:3-->
-The '''TitleKey''' extension provides a case-insensitive page title prefix search.</translate>
-<translate>
-<!--T:4-->
-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 <tvar|1>{{ll|Extension:CirrusSearch|nsp=0}}</>.
+<translate>
 <!--T:5-->
-For the average site administrator, the benefit of this extension is that it allows search suggestions (e.g. from <tvar|1>{{ll|API:opensearch|nsp=0}}</> API) to be case-'''in'''sensitive.
+For the average site administrator, the benefit of this extension is that it allows search suggestions (e.g., from <tvar name=1>{{Ll|API:opensearch|nsp=0}}</tvar> API) to be case-'''in'''sensitive.
 </translate>
+{{Note
-{{Note|1=<translate><!--T:6--> This extension provides no benefit if you are using <tvar|1>{{ll|Extension:CirrusSearch|nsp=0}}</>.</translate>}}
+ |1=<translate><!--T:6--> This extension provides no benefit if you are using <tvar name=1>{{Ll|Extension:CirrusSearch|nsp=0}}</tvar>.</translate>
+}}
 <translate>
 == Installation == <!--T:7-->
 </translate>
@@ Line 33: / Line 30: @@
 |repo-name=TitleKey
 |db-update=Yes
+|localsettings=
-|custom-steps=* <translate><!--T:8--> Run the "rebuildTitleKeys.php" script (this requires command-line access):</translate>
+// For MW 1.43.0 and above, no further configuration is needed.
-: <syntaxhighlight lang="bash">php extensions/TitleKey/rebuildTitleKeys.php</syntaxhighlight>
-|registration=Yes
+// 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;
+|registration=required
 |no-registration-version=1.27
 }}
+== Maintenance ==
-<translate>
+<translate><!--T:17--> The RebuildTitleKeys maintenance script can be used at any time to rebuild the title index  (this requires command-line access):</translate><div><syntaxhighlight lang="bash">$ path/to/mediawiki/maintenance/run RebuildTitleKeys</syntaxhighlight>Or, for MediaWiki before 1.40:<syntaxhighlight lang="bash">$ php path/to/mediawiki/extensions/TitleKey/maintenance/rebuildTitleKeys.php</syntaxhighlight></div>
-== Known problems == <!--T:9-->
+{{Used by}}
-<!--T:10-->
-* It breaks {{ll|Extension:VisualEditor|nsp=0}} autocompletion for templates </translate>([[Topic:Uci3j110eoxumevd|<translate><!--T:11--> see topic</translate>]]).
-* <translate><!--T:12--> It breaks any extension that relies on {{ll|API:Prefixsearch|nsp=0}} which also includes {{ll|Extension:TemplateWizard|nsp=0}}.</translate>
-* <translate>It breaks search suggestions for pages that are not in the main namespace.</translate> <translate>(There is an unmerged Gerrit patch that would fix this issue: <tvar|1>{{Gerrit|641277}}</>.)</translate>

TitleKey Release status: stable
Implementation	Search
Description	Provides a case-insensitive page title prefix search
Author(s)	Brooke Vibber^talk
Latest version	continuous updates
MediaWiki	1.25+
Database changes	Yes
Tables	titlekey
License	GNU General Public License 2.0 or later
Download	Download extension Git ^[?]: Download Git master browse repository (GitHub) commit history repository contributors (GitHub) code review README
Hooks used LoadExtensionSchemaUpdates PageDeleteComplete PageMoveCompleting PageSaveComplete PageUndeleteComplete
Quarterly downloads	65 (Ranked 78^th)
Translate the TitleKey extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug