Difference between revisions of "Module:Redirect hatnote/sandbox"

From blackwiki
Jump to navigation Jump to search
test>Nihiltres
(Conversion of the remainder. Not feeling 100%, but time to check my work)
m (25 revisions imported)
 
(17 intermediate revisions by 3 users 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
Line 22: 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
+
-- Create the options table.
if type(k) == 'number' and k > maxArg then
+
local options = {}
maxArg = k
+
options.selfref = args.selfref
end
+
return p._redirect(args, numRedirects, options)
v = v:match('^%s*(.-)%s*$') -- Trim whitespace
+
end
if v ~= '' then
 
args[k] = v
 
end
 
end
 
  
--Get table of redirects
+
function p._redirect(args, numRedirects, options, currentTitle, redirectTitle, targetTitle)
local numRedirects = tonumber(frame.args[1]) or 1
+
-- 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 = {}
 
local redirect = {}
 
for i = 1, numRedirects do
 
for i = 1, numRedirects do
-- Return an error if no redirect was specified.
+
-- Return an error if a redirect parameter is missing.
 
if not args[i] then
 
if not args[i] then
 
return mHatnote.makeWikitextError(
 
return mHatnote.makeWikitextError(
'no redirect specified',
+
'missing redirect parameter',
 
'Template:Redirect#Errors',
 
'Template:Redirect#Errors',
 
args.category
 
args.category
Line 50: Line 56:
 
redirect[i] = args[i]
 
redirect[i] = args[i]
 
end
 
end
 
 
-- Create the data table.
 
local data = {}
 
local iArg = -1 + numRedirects
 
local iData = 0 + numRedirects
 
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.
 
local options = {}
 
options.selfref = args.selfref
 
 
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[1] 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
 
 
function p._redirect(redirect, data, options, currentTitle, redirectTitle, targetTitle)
 
-- Validate the input. Don't bother checking currentTitle, redirectTitle or
 
-- targetTitle, as they are only used in testing.
 
checkTypeMulti('_redirect', 1, redirect, {'string', 'table'})
 
--string type can stay valid until extant use-cases are checked-for and updated,
 
--but we'll coerce them to table for now
 
if type(redirect) == "string" then redirect = {redirect} end
 
checkType('_redirect', 2, data, 'table', true)
 
checkType('_redirect', 3, options, 'table', true)
 
data = data or {}
 
options = options or {}
 
currentTitle = currentTitle or mw.title.getCurrentTitle()
 
 
 
-- Generate the text.
 
-- Generate the text.
local text = {}
 
 
local formattedRedirect = {}
 
local formattedRedirect = {}
 
for k,v in pairs(redirect) do
 
for k,v in pairs(redirect) do
 
formattedRedirect[k] = '"' .. v .. '"'
 
formattedRedirect[k] = '"' .. v .. '"'
 
end
 
end
text[#text + 1] = mw.text.listToText(formattedRedirect) .. (#redirect == 1 and 'redirects' or 'redirect') .. ' here.'
+
local text = {
text[#text + 1] = formatUseTable(data[1] or {}, true, redirect)
+
mHatList.andList(formattedRedirect) .. ' ' .. (#redirect == 1 and 'redirects' or 'redirect') .. ' here.',
if data[1] and data[1].use and data[1].use ~= 'other uses' then
+
mHatList._forSee(args, #redirect + 1, {title = redirect[1], extratext = args.text})
for i = 2, #data do
+
}
text[#text + 1] = formatUseTable(data[i] or {}, false)
 
end
 
end
 
 
text = table.concat(text, ' ')
 
text = table.concat(text, ' ')
+
-- Functionality for adding categories
 
local categoryTable = {}
 
local categoryTable = {}
--add categories to a table by index, so we don't get duplicates
 
 
function addCategory(cat)
 
function addCategory(cat)
 
if cat and cat ~= '' then
 
if cat and cat ~= '' then
 +
-- Add by index to avoid duplicates
 
categoryTable[string.format('[[Category:%s]]', cat)] = true
 
categoryTable[string.format('[[Category:%s]]', cat)] = true
 
end
 
end
 
end
 
end
 
+
--Generate tracking categories
 
local mhOptions = {}
 
local mhOptions = {}
 
for k,v in pairs(redirect) do
 
for k,v in pairs(redirect) do
-- Generate the tracking category.
+
redirectTitle = redirectTitle or getTitle(v)
-- We don't need a tracking category if the template invocation has been
+
local tracking = p._trackingcats(v, currentTitle);
-- copied directly from the docs, or if we aren't in mainspace or category-space.
+
if tracking then
if not v:find('^REDIRECT%d*$') and v ~= 'TERM' --
+
addCategory(tracking)
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
 
end
 
 
-- Generate the options to pass to [[Module:Hatnote]].
 
-- Generate the options to pass to [[Module:Hatnote]].
 
if currentTitle.namespace == 0 and not mhOptions.selfref
 
if currentTitle.namespace == 0 and not mhOptions.selfref
Line 182: Line 87:
 
then
 
then
 
-- We are on a mainspace page, and the hatnote starts with something
 
-- We are on a mainspace page, and the hatnote starts with something
-- like "Wikipedia:Foo redirects here", so automatically label it as a
+
-- like "Wikipedia:Foo redirects here", so automatically label it as
-- self-reference.
+
-- a self-reference.
 
mhOptions.selfref = true
 
mhOptions.selfref = true
 
else
 
else
Line 194: Line 99:
 
category = category .. k
 
category = category .. k
 
end
 
end
 
 
return mHatnote._hatnote(text, mhOptions) .. category
 
return mHatnote._hatnote(text, mhOptions) .. category
 
end
 
end
+
function p.trackingcats(frame)
 +
local category = p._trackingcats(frame.args[1])
 +
if category then
 +
return string.format('[[Category:%s]]', category)
 +
else
 +
return ''
 +
end
 +
end
 +
function p._trackingcats(redirect, currentTitle)
 +
-- 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.
 +
currentTitle = currentTitle or mw.title.getCurrentTitle()
 +
if not redirect:find('^REDIRECT%d*$') and redirect ~= 'TERM' --
 +
and currentTitle.namespace == 0 or currentTitle.namespace == 14
 +
then
 +
redirectTitle = redirectTitle or getTitle(redirect)
 +
if not redirectTitle or not redirectTitle.exists then
 +
return 'Missing redirects'
 +
elseif not redirectTitle.isRedirect then
 +
return '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
 +
return 'Articles with redirect hatnotes needing review'
 +
end
 +
end
 +
end
 +
end
 
return p
 
return p

Latest revision as of 11:38, 7 September 2020

Documentation for this module may be created at Module:Redirect hatnote/sandbox/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
		redirectTitle = redirectTitle or getTitle(v)
		local tracking = p._trackingcats(v, currentTitle);
		if tracking then
			addCategory(tracking)
		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
function p.trackingcats(frame) 
	local category = p._trackingcats(frame.args[1])
	if category then
		return string.format('[[Category:%s]]', category)
	else
		return ''
	end
end
function p._trackingcats(redirect, currentTitle) 
	-- 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.
	currentTitle = currentTitle or mw.title.getCurrentTitle()
	if not redirect:find('^REDIRECT%d*$') and redirect ~= 'TERM' -- 
		and currentTitle.namespace == 0 or currentTitle.namespace == 14
	then
		redirectTitle = redirectTitle or getTitle(redirect)
		if not redirectTitle or not redirectTitle.exists then
			return 'Missing redirects'
		elseif not redirectTitle.isRedirect then
			return '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
				return 'Articles with redirect hatnotes needing review'
			end
		end
	end
end
return p