Module:File link and Module:For: Difference between pages

From Polyphasic Sleep Wiki
(Difference between pages)
m 1 revision imported
 
m 1 revision imported
 
Line 1: Line 1:
-- This module provides a library for formatting file wikilinks.
local mArguments --initialize lazily
 
local mHatlist = require('Module:Hatnote list')
local yesno = require('Module:Yesno')
local mHatnote = require('Module:Hatnote')
local checkType = require('libraryUtil').checkType
local yesNo = require('Module:Yesno')
 
local p = {}
local p = {}


function p._main(args)
--Implements {{For}} from the frame
checkType('_main', 1, args, 'table')
--uses capitalized "For" to avoid collision with Lua reserved word "for"
 
function p.For (frame)
-- This is basically libraryUtil.checkTypeForNamedArg, but we are rolling our
mArguments = require('Module:Arguments')
-- own function to get the right error level.
return p._For(mArguments.getArgs(frame))
local function checkArg(key, val, level)
if type(val) ~= 'string' then
error(string.format(
"type error in '%s' parameter of '_main' (expected string, got %s)",
key, type(val)
), level)
end
end
 
local ret = {}
 
-- Adds a positional parameter to the buffer.
local function addPositional(key)
local val = args[key]
if not val then
return nil
end
checkArg(key, val, 4)
ret[#ret + 1] = val
end
 
-- Adds a named parameter to the buffer. We assume that the parameter name
-- is the same as the argument key.
local function addNamed(key)
local val = args[key]
if not val then
return nil
end
checkArg(key, val, 4)
ret[#ret + 1] = key .. '=' .. val
end
 
-- Filename
checkArg('file', args.file, 3)
ret[#ret + 1] = 'File:' .. args.file
 
-- Format
if args.format then
checkArg('format', args.format)
if args.formatfile then
checkArg('formatfile', args.formatfile)
ret[#ret + 1] = args.format .. '=' .. args.formatfile
else
ret[#ret + 1] = args.format
end
end
 
-- Border
if yesno(args.border) then
ret[#ret + 1] = 'border'
end
 
addPositional('location')
addPositional('alignment')
addPositional('size')
addNamed('upright')
addNamed('link')
addNamed('alt')
addNamed('page')
addNamed('class')
addNamed('lang')
addNamed('start')
addNamed('end')
addNamed('thumbtime')
addPositional('caption')
 
return string.format('[[%s]]', table.concat(ret, '|'))
end
end


function p.main(frame)
--Implements {{For}} but takes a manual arguments table
local origArgs = require('Module:Arguments').getArgs(frame, {
function p._For (args)
wrappers = 'Template:File link'
local use = args[1]
})
if (not use) then
if not origArgs.file then
return mHatnote.makeWikitextError(
error("'file' parameter missing from [[Template:File link]]", 0)
'no context parameter provided. Use {{other uses}} for "other uses" hatnotes.',
end
'Template:For#Errors',
 
args.category
-- Copy the arguments that were passed to a new table to avoid looking up
)
-- every possible parameter in the frame object.
local args = {}
for k, v in pairs(origArgs) do
-- Make _BLANK a special argument to add a blank parameter. For use in
-- conditional templates etc. it is useful for blank arguments to be
-- ignored, but we still need a way to specify them so that we can do
-- things like [[File:Example.png|link=]].
if v == '_BLANK' then
v = ''
end
args[k] = v
end
end
return p._main(args)
local pages = {}
function two (a, b) return a, b, 1 end --lets us run ipairs from 2
for k, v in two(ipairs(args)) do table.insert(pages, v) end
local title = mw.title.getCurrentTitle()
local skipCat = title.isTalkPage or title.namespace == 2 --don't categorise talk pages and userspace
local oddCat = skipCat and '' or '[[Category:Hatnote templates using unusual parameters]]'
local category = yesNo(args.category)
return mHatnote._hatnote(
mHatlist.forSeeTableToString({{use = use, pages = pages}}),
{selfref = args.selfref}
) .. (
(use == 'other uses') and ((category == true) or (category == nil)) and
oddCat or ''
)
end
end


return p
return p

Latest revision as of 20:15, 14 November 2020

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

local mArguments --initialize lazily
local mHatlist = require('Module:Hatnote list')
local mHatnote = require('Module:Hatnote')
local yesNo = require('Module:Yesno')
local p = {}

--Implements {{For}} from the frame
--uses capitalized "For" to avoid collision with Lua reserved word "for"
function p.For (frame)
	mArguments = require('Module:Arguments')
	return p._For(mArguments.getArgs(frame))
end

--Implements {{For}} but takes a manual arguments table
function p._For (args)
	local use = args[1]
	if (not use) then
		return mHatnote.makeWikitextError(
			'no context parameter provided. Use {{other uses}} for "other uses" hatnotes.',
			'Template:For#Errors',
			args.category
		)
	end
	local pages = {}
	function two (a, b) return a, b, 1 end --lets us run ipairs from 2
	for k, v in two(ipairs(args)) do table.insert(pages, v) end
	local title = mw.title.getCurrentTitle()
	local skipCat = title.isTalkPage or title.namespace == 2 --don't categorise talk pages and userspace
	local oddCat = skipCat and '' or '[[Category:Hatnote templates using unusual parameters]]'
	local category = yesNo(args.category)
	return mHatnote._hatnote(
		mHatlist.forSeeTableToString({{use = use, pages = pages}}),
		{selfref = args.selfref}
	) .. (
			(use == 'other uses') and ((category == true) or (category == nil)) and
			oddCat or ''
		)
end

return p
Retrieved from "https://polysleep.org/index.php?title=Module:File_link&oldid=400"