Jump to content

Extension:TitleKey: Difference between revisions

Issue tracker: #mediawiki-extensions-titlekey
From mediawiki.org
Browse history interactively
← Older edit
Content deleted Content added
VisualWikitext
Marked this version for translation
correct like this?
 
(33 intermediate revisions by 16 users not shown)
Line 1: Line 1:
<languages/>
<languages />
{{Extension
{{Extension
|status = stable
|status = stable
Line 6: Line 6:
|version = <translate><!--T:1--> continuous updates</translate>
|version = <translate><!--T:1--> continuous updates</translate>
|description = <translate><!--T:2--> Provides a case-insensitive page title prefix search</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}}
|download = {{WikimediaDownload|TitleKey}}
|changelog =
|changelog =
Line 14: Line 13:
|table1 = titlekey
|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-->
<!--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>
</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>
<translate>

== Installation == <!--T:7-->
== Installation == <!--T:7-->
</translate>
</translate>
Line 33: Line 30:
|repo-name=TitleKey
|repo-name=TitleKey
|db-update=Yes
|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
|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-->

<!--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>


{{Used by}}
{{ShippedWithBlueSpice}}

Latest revision as of 07:37, 2 December 2024

Languages:
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 [?]:

README
Hooks used
Quarterly downloads 62 (Ranked 70th)
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.

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' );
// 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.
  • Yes 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 before 1.40:
$ php path/to/mediawiki/extensions/TitleKey/maintenance/rebuildTitleKeys.php
Retrieved from "https://www.mediawiki.org/w/index.php?title=Extension:TitleKey&oldid=6882175"