Difference between revisions of "Module:Redirect hatnote"

From All About Ayrshire
Jump to: navigation, search
m (1 revision)
m (1 revision imported)
 
(One intermediate revision by one other user not shown)
Line 6: Line 6:
  
 
local mHatnote = require('Module:Hatnote')
 
local mHatnote = require('Module:Hatnote')
 +
local mHatList = require('Module:Hatnote list')
 +
local mArguments --lazily initialize
 
local libraryUtil = require('libraryUtil')
 
local libraryUtil = require('libraryUtil')
 
local checkType = libraryUtil.checkType
 
local checkType = libraryUtil.checkType
 +
local checkTypeMulti = libraryUtil.checkTypeMulti
  
 
local p = {}
 
local p = {}
Line 21: Line 24:
  
 
function p.redirect(frame)
 
function p.redirect(frame)
−
-- Get the args table and work out the maximum arg key.
+
mArguments = require('Module:Arguments')
−
local origArgs = frame:getParent().args
+
local args = mArguments.getArgs(frame, {parentOnly=true})
−
local args = {}
+
--Get number of redirects
−
local maxArg = 0
+
local numRedirects = tonumber(frame.args[1]) or 1
−
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
 
−
 
 
−
-- Return an error if no redirect was specified.
 
−
local redirect = args[1]
 
−
if not redirect then
 
−
return mHatnote.makeWikitextError(
 
−
'no redirect specified',
 
−
'Template:Redirect#Errors',
 
−
args.category
 
−
)
 
−
end
 
−
 
 
−
-- Create the data table.
 
−
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
 
−
 
 
 
-- Create the options table.
 
-- Create the options table.
 
local options = {}
 
local options = {}
 
options.selfref = args.selfref
 
options.selfref = args.selfref
−
+
return p._redirect(args, numRedirects, options)
−
return p._redirect(redirect, data, options)
 
−
end
 
−
 
 
−
local function formatUseTable(useTable, isFirst, redirect)
 
−
-- Formats one use table. Use tables are the tables inside the data array.
 
−
-- Each one corresponds to one use. (A use might be the word "cats" in the
 
−
-- phrase "For cats, see [[Felines]]".)
 
−
-- Returns a string, or nil if no use was specified.
 
−
-- The isFirst parameter is used to apply special formatting for the first
 
−
-- table in the data array. If isFirst is specified, the redirect parameter
 
−
useTable = useTable or {}
 
−
local use
 
−
if isFirst then
 
−
use = useTable.use or 'other uses'
 
−
elseif not useTable.use then
 
−
return nil
 
−
elseif tonumber(useTable.use) == 1 then
 
−
use = 'other uses'
 
−
else
 
−
use = useTable.use
 
−
end
 
−
local pages = useTable.pages or {}
 
−
if isFirst then
 
−
redirect = redirect or error(
 
−
'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
 
−
pages = mHatnote.formatPages(unpack(pages))
 
−
pages = mw.text.listToText(pages)
 
−
return string.format(
 
−
'For %s, see %s.',
 
−
use,
 
−
pages
 
−
)
 
 
end
 
end
  
−
function p._redirect(redirect, data, options, currentTitle, redirectTitle, targetTitle)
+
function p._redirect(args, numRedirects, options, currentTitle, redirectTitle, targetTitle)
 
-- Validate the input. Don't bother checking currentTitle, redirectTitle or
 
-- Validate the input. Don't bother checking currentTitle, redirectTitle or
 
-- targetTitle, as they are only used in testing.
 
-- targetTitle, as they are only used in testing.
−
checkType('_redirect', 1, redirect, 'string')
+
checkType('_redirect', 1, args, 'table')
−
checkType('_redirect', 2, data, 'table', true)
+
checkType('_redirect', 2, numRedirects, 'number', true)
 +
numRedirects = numRedirects or 1
 
checkType('_redirect', 3, options, 'table', true)
 
checkType('_redirect', 3, options, 'table', true)
−
data = data or {}
 
 
options = options or {}
 
options = options or {}
 
currentTitle = currentTitle or mw.title.getCurrentTitle()
 
currentTitle = currentTitle or mw.title.getCurrentTitle()
−
 
+
-- Get the table of redirects
 +
local redirect = {}
 +
for i = 1, numRedirects do
 +
-- Return an error if a redirect parameter is missing.
 +
if not args[i] then
 +
return mHatnote.makeWikitextError(
 +
'missing redirect parameter',
 +
'Template:Redirect#Errors',
 +
args.category
 +
)
 +
end
 +
redirect[i] = args[i]
 +
end
 
-- Generate the text.
 
-- Generate the text.
−
local text = {}
+
local formattedRedirect = {}
−
text[#text + 1] = '"' .. redirect .. '" redirects here.'
+
for k,v in pairs(redirect) do
−
text[#text + 1] = formatUseTable(data[1] or {}, true, redirect)
+
formattedRedirect[k] = '"' .. v .. '"'
−
if data[1] and data[1].use and data[1].use ~= 'other uses' then
+
end
−
for i = 2, #data do
+
local text = {
−
text[#text + 1] = formatUseTable(data[i] or {}, false)
+
mHatList.andList(formattedRedirect) .. ' ' .. (#redirect == 1 and 'redirects' or 'redirect') .. ' here.',
 +
mHatList._forSee(args, #redirect + 1, {title = redirect[1], extratext = args.text})
 +
}
 +
text = table.concat(text, ' ')
 +
-- Functionality for adding categories
 +
local categoryTable = {}
 +
function addCategory(cat)
 +
if cat and cat ~= '' then
 +
-- Add by index to avoid duplicates
 +
categoryTable[string.format('[[Category:%s]]', cat)] = true
 
end
 
end
 
end
 
end
−
text = table.concat(text, ' ')
+
--Generate tracking categories
−
+
local mhOptions = {}
−
-- Generate the tracking category.
+
for k,v in pairs(redirect) do
−
-- We don't need a tracking category if the template invocation has been
+
-- We don't need a tracking category if the template invocation has been
−
-- copied directly from the docs, or if we aren't in mainspace.
+
-- copied directly from the docs, or if we aren't in main- or category-space.
−
local category
+
if not v:find('^REDIRECT%d*$') and v ~= 'TERM' --  
−
if not redirect:find('^REDIRECT%d*$') and redirect ~= 'TERM' --  
+
and currentTitle.namespace == 0 or currentTitle.namespace == 14
−
and currentTitle.namespace == 0
+
then
−
then
+
redirectTitle = redirectTitle or getTitle(v)
−
redirectTitle = redirectTitle or getTitle(redirect)
+
if not redirectTitle or not redirectTitle.exists then
−
if not redirectTitle or not redirectTitle.exists then
+
addCategory('Missing redirects')
−
category = 'Missing redirects'
+
elseif not redirectTitle.isRedirect then
−
elseif not redirectTitle.isRedirect then
+
addCategory('Articles with redirect hatnotes needing review')
−
category = 'Articles with redirect hatnotes needing review'
+
else
 +
local mRedirect = require('Module:Redirect')
 +
local target = mRedirect.getTarget(redirectTitle)
 +
targetTitle = targetTitle or target and getTitle(target)
 +
if targetTitle and targetTitle ~= 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 redirectTitle and redirectTitle.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
 
else
−
local mRedirect = require('Module:Redirect')
+
mhOptions.selfref = options.selfref
−
local target = mRedirect.getTarget(redirectTitle)
 
−
targetTitle = targetTitle or target and getTitle(target)
 
−
if targetTitle and targetTitle ~= currentTitle then
 
−
category = 'Articles with redirect hatnotes needing review'
 
−
end
 
 
end
 
end
 
end
 
end
−
category = category and string.format('[[Category:%s]]', category) or ''
+
--concatenate all the categories
−
 
+
local category = ''
−
-- Generate the options to pass to [[Module:Hatnote]].
+
for k,v in pairs(categoryTable) do
−
local mhOptions = {}
+
category = category .. k
−
if currentTitle.namespace == 0
 
−
and redirectTitle and redirectTitle.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
  

Latest revision as of 19:36, 27 December 2020

Documentation for this module may be created at Module:Redirect hatnote/doc 

--[[
-- This module produces a "redirect" hatnote. It looks like this:
-- '"X" redirects here. For other uses, see Y.'
-- It implements the {{redirect}} template.
--]]

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 = {}

local function getTitle(...)
	local success, titleObj = pcall(mw.title.new, ...)
	if success then
		return titleObj
	else
		return nil
	end
end

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)
end

function p._redirect(args, numRedirects, options, currentTitle, redirectTitle, targetTitle)
	-- Validate the input. Don't bother checking currentTitle, redirectTitle or
	-- targetTitle, as they are only used in testing.
	checkType('_redirect', 1, args, 'table')
	checkType('_redirect', 2, numRedirects, 'number', true)
	numRedirects = numRedirects or 1
	checkType('_redirect', 3, options, 'table', true)
	options = options or {}
	currentTitle = currentTitle or mw.title.getCurrentTitle()
	-- Get the table of redirects
	local redirect = {}
	for i = 1, numRedirects do
		-- Return an error if a redirect parameter is missing.
		if not args[i] then
			return mHatnote.makeWikitextError(
				'missing redirect parameter',
				'Template:Redirect#Errors',
				args.category
			)
		end
		redirect[i] = args[i]
	end
	-- Generate the text.
	local formattedRedirect = {}
	for k,v in pairs(redirect) do
		formattedRedirect[k] = '"' .. v .. '"'
	end
	local text = {
		mHatList.andList(formattedRedirect) .. ' ' .. (#redirect == 1 and 'redirects' or 'redirect') .. ' here.',
		mHatList._forSee(args, #redirect + 1, {title = redirect[1], extratext = args.text})
	}
	text = table.concat(text, ' ')
	-- Functionality for adding categories	
	local categoryTable = {}
	function addCategory(cat)
		if cat and cat ~= '' then
			-- Add by index to avoid duplicates
			categoryTable[string.format('[[Category:%s]]', cat)] = true
		end
	end
	--Generate tracking categories
	local mhOptions = {}
	for k,v in pairs(redirect) do
		-- We don't need a tracking category if the template invocation has been
		-- copied directly from the docs, or if we aren't in main- or category-space.
		if not v:find('^REDIRECT%d*$') and v ~= 'TERM' -- 
			and currentTitle.namespace == 0 or currentTitle.namespace == 14
		then
			redirectTitle = redirectTitle or getTitle(v)
			if not redirectTitle or not redirectTitle.exists then
				addCategory('Missing redirects')
			elseif not redirectTitle.isRedirect then
				addCategory('Articles with redirect hatnotes needing review')
			else
				local mRedirect = require('Module:Redirect')
				local target = mRedirect.getTarget(redirectTitle)
				targetTitle = targetTitle or target and getTitle(target)
				if targetTitle and targetTitle ~= 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 redirectTitle and redirectTitle.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

	return mHatnote._hatnote(text, mhOptions) .. category
end
 
return p
Retrieved from "http://igoaddons.eu.org/index.php?title=Module:Redirect_hatnote&oldid=11127"