Extension:CategorySortHeaders
CategorySortHeaders Release status: stable |
|
---|---|
Implementation | Hook |
Description | Make custom headings in category pages, instead of just the first character headings |
Author(s) | |
Latest version | 0.4.0 (2021-04-20) |
MediaWiki | 1.35+ |
Database changes | No |
License | GNU General Public License 2.0 or later |
Download | |
|
|
Quarterly downloads | 4 (Ranked 128th) |
Translate the CategorySortHeaders extension if it is available at translatewiki.net | |
The CategorySortHeaders extension to allow specifying custom multi-character 'first-character' sorting headers to list pages under in categories, using syntax like [[Category:Foo|^Header^Invisible part of sortkey]]
or even just [[Category:Foo|^Header^]].
Usage
If you want a category to use a custom header, do [[Category:Cat name|^header^OptionalInvisibleSortkey]]
(or {{DEFAULTSORT:^header^Optionalsortkey}}.
If you want to use the default first letter headers, just use categories as normal.
Installation
- Download and move the extracted
CategorySortHeaders
folder to yourextensions/
directory.
Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CategorySortHeaders - Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'CategorySortHeaders' );
- Run either
update.php
orupdateCollation.php
from the command line (Note that running the web installer in upgrade mode does not work due to task T19335) - Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
To users running MediaWiki 1.35 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.35 and earlier), instead of wfLoadExtension( 'CategorySortHeaders' );
, you need to use:
require_once "$IP/extensions/CategorySortHeaders/CategorySortHeaders.php";
Configuration
This extension has a single configuration option:
$wgCategorySortHeaderAppendPageNameToKey
- It defaults to true, which causes a sortkey of
^foo^
to be treated like^foo^{{PAGENAME}}
. If it is set to false, it will sort^foo^
above^foo^<any string here>
. (In both cases, if there are two exactly same sort keys, the pagename will be used as a tie breaker.) After changing this option you should run:
php updateCollation.php --force
See also
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. |