Module:Sort title/doc
Appearance
This is a documentation subpage for Module:Sort title. It may contain usage information, categories and other content that is not part of the original module page. |
This Lua module is used on approximately 22,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them. |
This module depends on the following other modules: |
Module:Sort title is used to create sortkeys for pages.
What it does
[edit]The module preforms the following checks:
- If the first word of the title is an article, it moves it to the end of the title. For example:
The Avengers
will have a sortkey ofAvengers, The
. - If the title is disambiguated and the first word of the disambiguation is an article, it moves it to the end of the disambiguation. For example:
Pilot (The Flash)
will have a sortkey ofPilot (Flash, The)
. - If the title is disambiguated and the first word of the title and the disambiguation is an article, both of the above changes will occur. For example:
The End (A Series of Unfortunate Events)
will have a sortkey ofEnd, The (Series of Unfortunate Events, A)
. - If the title is a number which is separated by a commas, it removes the commas. For example:
4,722 Hours
will have a sortkey of4722 Hours
.
Usage
[edit]From template:
{{#invoke:Sort title|getSortKey}}
{{#invoke:Sort title|getDefaultSort}}
From module:
local sortkeyModule = require('Module:Sort title')
local sortkey = sortkeyModule._getSortKey()
Function list
[edit]Function | Explanation |
---|---|
getSortKey
|
Returns a sortkey |
getDefaultSort
|
Returns a DEFAULTSORT string |