Module:Resolve category redirect/sandbox
This is the module sandbox page for Module:Resolve category redirect (diff). |
This Lua module is used in MediaWiki:Babel-category-override, and on approximately 909,000 pages, or roughly 1% of all pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. |
This module depends on the following other modules: |
Related pages |
---|
About
[edit]This template resolves soft category redirects.
It takes one parameter, which is the name of a category. If successful, it will return the target of {{category redirect|<target>}}
on that category. If unsuccessful, it will return its own original parameter.
Usage
[edit]{{Resolve category redirect|categoryname}}
Examples
[edit]Category exists and is not redirected: Category:1970s
[edit]{{Resolve category redirect|1970s}}
→ 1970s{{Resolve category redirect|Category:1970s}}
→ 1970s
Category exists and is a soft redirect: Category:Mosques completed in the 19th century
[edit]{{Resolve category redirect|Mosques completed in the 19th century}}
→ 19th-century mosques{{Resolve category redirect|Category:Mosques completed in the 19th century}}
→ 19th-century mosques
Category exists and is a soft redirect: Category:Organisations
[edit]{{Resolve category redirect|Organisations}}
→ Organizations{{Resolve category redirect|Category:Organisations}}
→ Organizations
Non-existent category: Category:Colourless green things
[edit]{{Resolve category redirect|Colourless green things}}
→ Colourless green things{{Resolve category redirect|Category:Colourless green things}}
→ Colourless green things
{{Title year}} in category: Category:1781 in Mexico
[edit]{{Resolve category redirect|1781 in Mexico}}
→ 1781 in New Spain{{Resolve category redirect|Category:1781 in Mexico}}
→ 1781 in New Spain
Templates
[edit]{{Title year}} and other templates without parameters are now allowed in the {{Category redirect}} target name, as well as basic parser functions, and are evaluated accordingly. Multiple templates are not evaluated, but such functionality can be requested with an appropriate working example.
The character !
is also now allowed (see testcases).
Avoiding deletion of the redirected page
[edit]It is helpful to also add {{R from category navigation}} or {{R from template-generated category}} (as appropriate) to indicate that the redirect is required for navigation between category pages. See those template page for full syntax. This also hides a speedy deletion button that is otherwise displayed to administrators.
Tracking categories
[edit]See also
[edit]local p = {}
local function cleanup( rtarget )
rtarget = mw.text.trim( rtarget )
rtarget = mw.ustring.gsub( rtarget, '^1%s*=%s*', '' )
rtarget = string.gsub( rtarget, '^[Cc]ategory:', '' )
return rtarget
end
--Returns the target of {{Category redirect}}, if it exists, else returns the original cat.
function p.rtarget( cat, frame )
cat = string.gsub( cat, '^[Cc]ategory:', '' ) --"!" in cat not recognized by mw.title.makeTitle() otherwise
if string.match( cat, '[|]' ) then
return cat
end
local catcontent = mw.title.makeTitle( 'Category', cat or '' ):getContent() --makeTitle() allows ':' in cat names
if string.match( catcontent or '', '{{ *[Cc]at' ) then --regex common to all possible calls
catcontent = mw.ustring.gsub( catcontent, '|%s*keep%s*=%s*[yY]?[eE]?[sS]?%s*', '' ) --remove other params
local getRegex = require('Module:Template redirect regex').main
local tregex = getRegex('Category redirect')
for _, v in pairs (tregex) do
local found = mw.ustring.match( catcontent, v..'%s*|' )
if found then --refine
local rtarget = mw.ustring.match( catcontent, v..'%s*|%s*([^{|}]+)}}' ) or --{{Category redirect|...}} (most common)
mw.ustring.match( catcontent, v..'%s*|%s*([^{|}]+)|' ) --{{Category redirect|...|...}} (2nd most common)
if rtarget then --normal, plain text target
return cleanup(rtarget)
else
local ty_regex = '%s*|%s*([^{|}]*{{([^#][^{|}]+)}}[^{|}]*)' --$1 nests $2
local rtarget_orig, ty = mw.ustring.match( catcontent, v..ty_regex )
if rtarget_ty then --{{Category redirect|...{{Title year}}... (less common)
local ty_eval = frame:expandTemplate{ title = ty, args = { page = cat } } --frame:newChild doesn't work, use 'page' param instead
local rtarget_ty_eval = mw.ustring.gsub( rtarget_ty, '{{%s*'..ty..'%s*}}', ty_eval )
return cleanup(rtarget_ty_eval)
else --resolve basic parser functions: e.g. {{#time:j F Y}} on Proposed deletion as of today (very uncommon)
local pf_regex = '%s*|%s*([^{|}]*{{%s*(#[^{|}#:]+):([^{|}#:]+)}}[^{|}]*)' --$1 nests $2 & $3
local rtarget_pf, pf, arg = mw.ustring.match( catcontent, v..pf_regex )
if rtarget_pf then
local pf_eval = frame:callParserFunction{ name = pf, args = { arg } }
local rtarget_pf_eval = mw.ustring.gsub( rtarget_pf, '{{%s*'..pf..'%s*:%s*'..arg..'%s*}}', pf_eval )
return cleanup(rtarget_pf_eval)
else --potential TODO: 1) +loop for multiple templates, 2) allow sub-parameters
return cat
end
end end end end end
return cat
end
function p.main( frame )
local args = frame:getParent().args
local cat = mw.text.trim( args[1] or '' )
if (cat == '') or (cat == nil) then
return ''
end
return p.rtarget( cat, frame )
end
return p