Module:Redirect hatnote: Difference between revisions

From the Croc Wiki, the Croc encyclopedia
Jump to navigationJump to search

Module:Redirect hatnote (view source)

Revision as of 18:10, August 8, 2023

338 bytes added ,  10 months ago
m
Protected "Module:Redirect hatnote": High traffic page ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))
(create a formatUseTable to reduce code redundancy)
m (Protected "Module:Redirect hatnote": High traffic page ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
 
(31 intermediate revisions by 8 users not shown)
Line 6:
 
local mHatnote = require('Module:Hatnote')
local mHatList = require('Module:Hatnote list')
local mArguments --lazily initialize
local libraryUtil = require('libraryUtil')
local checkType = libraryUtil.checkType
local checkTypeMulti = libraryUtil.checkTypeMulti
 
local p = {}
 
--------------------------------------------------------------------------------
function p.redirect(frame)
-- Helper functions
-- Get the args table and work out the maximum arg key.
--------------------------------------------------------------------------------
local origArgs = frame:getParent().args
local args = {}
local maxArg = 0
for k, v in pairs(origArgs) do
if type(k) == 'number' and k > maxArg then
maxArg = k
end
v = v:match('^%s*(.-)%s*$') -- Trim whitespace
if v ~= '' then
args[k] = v
end
end
 
local function getTitle(...)
-- Return an error if no redirect was specified.
--Calls mw.title.new and returns either a title object, or nil on error
local redirect = args[1]
local success, titleObj = pcall(mw.title.new, ...)
if not redirect then
return success and titleObj or nil
return mHatnote.makeWikitextError(
end
'no redirect specified',
'Template:Redirect#Errors',
args.category
)
end
 
--------------------------------------------------------------------------------
-- Create the data table.
-- Main functions
local data = {}
--------------------------------------------------------------------------------
local iArg = 0
local iData = 1
repeat
iArg = iArg + 2
local useTable = data[iData] or {}
local pages = useTable.pages or {}
local use = args[iArg]
local page = args[iArg + 1]
local nextUse = args[iArg + 2]
pages[#pages + 1] = page
useTable.pages = pages
if use ~= 'and' then
useTable.use = use
end
data[iData] = useTable
if nextUse ~= 'and' then
iData = iData + 1
end
until iArg >= maxArg - 1
 
function p.redirect(frame)
mArguments = require('Module:Arguments')
local args = mArguments.getArgs(frame, {parentOnly=true})
--Get number of redirects
local numRedirects = tonumber(frame.args[1]) or 1
-- Create the options table.
local options = {}
options.selfref = args.selfref
return p._redirect(args, numRedirects, options)
return p._redirect(redirect, data, options)
end
 
function p._redirect(args, numRedirects, options, currentTitle, redirectTitle, targetTitle)
local function formatUseTable(useTable, isFirst, redirect)
-- Validate the input. Don't bother checking currentTitle, redirectTitle or
-- Formats one use table. Use tables are the tables inside the data array.
-- targetTitle, as they are only used in testing.
-- Each one corresponds to one use. (A use might be the word "cats" in the
checkType('_redirect', 1, args, 'table')
-- phrase "For cats, see [[Felines]]".)
checkType('_redirect', 2, numRedirects, 'number', true)
-- Returns a string, or nil if no use was specified.
numRedirects = numRedirects or 1
-- The isFirst parameter is used to apply special formatting for the first
checkType('_redirect', 3, options, 'table', true)
-- table in the data array. If isFirst is specified, the redirect parameter
useTableoptions = useTableoptions or {}
currentTitle = currentTitle or mw.title.getCurrentTitle()
local use
-- Get the table of redirects
if isFirst then
local redirect = {}
use = useTable.use or 'other uses'
for i = 1, numRedirects do
elseif not useTable.use then
-- Return an error if a redirect parameter is missing.
return nil
if not args[i] then
elseif tonumber(useTable.use) == 1 then
return mHatnote.makeWikitextError(
use = 'other uses'
'missing redirect parameter',
else
'Template:Redirect#Errors',
use = useTable.use
args.category
)
end
redirect[i] = args[i]
end
-- Generate the text.
local pages = useTable.pages
local formattedRedirect = {}
if isFirst then
redirect for =k,v in pairs(redirect) or error(do
formattedRedirect[k] = mHatnote.quote(v)
'isFirst was set in formatUseTable, but no redirect was supplied',
2
)
pages[1] = pages[1] or redirect .. ' (disambiguation)'
else
pages[1] = pages[1] or useTable.use .. ' (disambiguation)'
end
local text = {
pages = mHatnote.formatPages(unpack(pages))
mHatList.andList(formattedRedirect) .. ' ' .. (#redirect == 1 and 'redirects' or 'redirect') .. ' here.',
pages = mw.text.listToText(pages)
mHatList._forSee(args, #redirect + 1, {title = redirect[1], extratext = args.text})
return string.format(
}
'For %s, see %s.',
text = table.concat(text, ' ')
use,
-- Functionality for adding categories
pages
local categoryTable = {}
)
local function addCategory(cat)
end
if cat and cat ~= '' then
 
-- Add by index to avoid duplicates
function p._redirect(redirect, data, options)
categoryTable[string.format('[[Category:%s]]', cat)] = true
checkType('_redirect', 1, redirect, 'string')
checkType('_redirect', 2, data, 'table', true)
checkType('_redirect', 3, options, 'table', true)
 
-- Generate the text.
local text = {}
text[#text + 1] = '"' .. redirect .. '" redirects here.'
text[#text + 1] = formatUseTable(data[1] or {}, true, redirect)
if data[1] and data[1].use and data[1].use ~= 'other uses' then
for i = 2, #data do
text[#text + 1] = formatUseTable(data[i] or {}, false)
end
end
--Generate tracking categories
text = table.concat(text, ' ')
-- Generate the options to pass to [[Module:Hatnote]].
options = options or {}
local mhOptions = {}
local redirTitle
mhOptions.selfref = options.selfref
for k,v in pairs(redirect) do
 
-- FindWe whetherdon't toneed add thea tracking category. if the template invocation has been
-- Wecopied adddirectly from the categorydocs, or if allwe ofaren't thein followingmain- areor true:category-space.
if not v:find('^REDIRECT%d*$') and v ~= 'TERM' --
-- a) redirect isn't any of the keywords 'REDIRECT', 'REDIRECT1',
and currentTitle.namespace == 0 or currentTitle.namespace == 14
-- 'REDIRECT2', ..., or 'TERM'.
then
-- b) we are in the main namespace.
redirTitle = redirectTitle or getTitle(v)
-- c) the redirect title does not exist.
if not redirTitle or not redirTitle.exists then
local category
addCategory('Missing redirects')
if not redirect:find('^REDIRECT%d*$') and redirect ~= 'TERM' then
elseif not redirTitle.isRedirect then
local currentTitle = mw.title.getCurrentTitle()
if string.find(redirTitle:getContent(), '#invoke:RfD') then
if currentTitle.namespace == 0 then
addCategory('Articles with redirect hatnotes impacted by RfD')
local success, redirectTitle = pcall(mw.title.new, redirect)
else
if success and not redirectTitle.exists then
addCategory('Articles with redirect hatnotes needing review')
category = '[[Category:Missing redirects]]'
end
else
local target = targetTitle or redirTitle.redirectTarget
if target and target ~= currentTitle then
addCategory('Articles with redirect hatnotes needing review')
end
end
end
 
-- Generate the options to pass to [[Module:Hatnote]].
if currentTitle.namespace == 0 and not mhOptions.selfref
and redirTitle and redirTitle.namespace ~= 0
then
-- We are on a mainspace page, and the hatnote starts with something
-- like "Wikipedia:Foo redirects here", so automatically label it as
-- a self-reference.
mhOptions.selfref = true
else
mhOptions.selfref = options.selfref
end
end
--concatenate all the categories
local category = ''
for k,v in pairs(categoryTable) do
category = category .. k
end
category = category or ''
 
return mHatnote._hatnote(text, mhOptions) .. category
Retrieved from "https://crocwiki.com/wiki/Special:MobileDiff/33890...34274"
Cookies help us deliver our services. By using our services, you agree to our use of cookies.
More information

Navigation menu