Module:File link - Revision history

Abinash: 20 revisions

2016-04-08T12:23:07Z

20 revisions

Abinash: 1 revision

2016-04-08T11:49:56Z

1 revision

Mr. Stradivarius: when calling this from wikitext use a more readable error message for missing file parameters

2014-12-18T14:05:07Z

when calling this from wikitext use a more readable error message for missing file parameters

New page

-- This module provides a library for formatting file wikilinks.

local yesno = require('Module:Yesno')
local checkType = require('libraryUtil').checkType

local p = {}

function p._main(args)
checkType('_main', 1, args, 'table')

-- This is basically libraryUtil.checkTypeForNamedArg, but we are rolling our
-- own function to get the right error level.
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

function p.main(frame)
local origArgs = require('Module:Arguments').getArgs(frame, {
wrappers = 'Template:File link'
})
if not origArgs.file then
error("'file' parameter missing from [[Template:File link]]", 0)
end

-- 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
return p._main(args)
end

return p

Mr. Stradivarius: use yesno to test whether to add a border

2014-12-18T13:24:28Z

use yesno to test whether to add a border

Mr. Stradivarius: make this a lot simpler - the original module was overkill for what it was trying to do

2014-12-18T12:32:08Z

make this a lot simpler - the original module was overkill for what it was trying to do

Show changes

Mr. Stradivarius: Undid revision 611451330 by Mr. Stradivarius (talk) whoops, that edit was supposed to be to the sandbox...

2014-06-04T00:06:16Z

Undid revision 611451330 by Mr. Stradivarius (talk) whoops, that edit was supposed to be to the sandbox...

Mr. Stradivarius: allow specifying height and width values as strings ending in px

2014-06-04T00:05:16Z

allow specifying height and width values as strings ending in px

Mr. Stradivarius: Protected Module:File link: High-risk Lua module ([Edit=Allow only template editors and admins] (indefinite) [Move=Allow only template editors and admins] (indefinite))

2014-06-03T08:57:49Z

Protected Module:File link: High-risk Lua module ([Edit=Allow only template editors and admins] (indefinite) [Move=Allow only template editors and admins] (indefinite))

Mr. Stradivarius: add start, end, and thumbtime

2014-05-31T14:59:01Z

add start, end, and thumbtime

Mr. Stradivarius: don't include the library name in checkSelf method names

2014-05-30T15:26:21Z

don't include the library name in checkSelf method names

@@ Line 5: / Line 5: @@
 local fileLink = {}
 function fileLink.new(filename)
@@ Line 64: / Line 52: @@
 	end
-	local function validateSize(method, px)
+	local function sizeError(methodName)
-		-- Validate input for size-related functions. The px type is checked
+		-- Used for formatting duplication errors in size-related methods.
-		-- using checkTypeStringOrNum, so will be a string, a number, or nil.
+		error(string.format(
-		if px and data.isUpright then
+			"duplicate size argument detected in '%s'"
-			error(string.format(
+			.. " ('upright' cannot be used in conjunction with height or width)",
-				"duplicate size argument detected in '%s' ('upright' cannot be"
+			methodName
-					.. ' used in conjunction with height or width)',
+		), 3)
-				method
-			), 3)
-		end
-		if type(px) == 'string' then
-			local origPx = px
-			px = px:match('^(%d+)px$') or px
-			px = tonumber(px)
-			if not px then
-				error(string.format(
-					"invalid string '%s' passed to '%s'",
-					origPx,
-					method
-				), 3)
-			end
-		end
-		-- px is now a number or nil.
-		if px and px < 1 or math.floor(px) ~= px then
-			error(string.format(
-				"invalid image size specified in '%s' (size must be a positive"
-					.. 'integer)',
-				method
-			), 3)
-		end
-		return px
 	end
-−
 	function data:width(px)
 		checkSelf(self, 'width')
-		checkTypeStringOrNum('fileLink:width', 1, px)
+		checkType('fileLink:width', 1, px, 'number', true)
-		px = validateSize('fileLink:width', px)
+		if px and data.isUpright then
 		data.theWidth = px
 		return self
@@ Line 107: / Line 73: @@
 	function data:height(px)
 		checkSelf(self, 'height')
-		checkTypeStringOrNum('fileLink:height', 1, px)
+		checkType('fileLink:height', 1, px, 'number', true)
-		px = validateSize('fileLink:height', px)
+		if px and data.isUpright then
 		data.theHeight = px
 		return self
@@ Line 217: / Line 185: @@
 		data.theLang = s
 		return self
 	end

@@ Line 5: / Line 5: @@
 local fileLink = {}
 function fileLink.new(filename)
@@ Line 52: / Line 64: @@
 	end
-	local function sizeError(methodName)
+	local function validateSize(method, px)
-		-- Used for formatting duplication errors in size-related methods.
+		-- Validate input for size-related functions. The px type is checked
-		error(string.format(
+		-- using checkTypeStringOrNum, so will be a string, a number, or nil.
-			"duplicate size argument detected in '%s'"
+		if px and data.isUpright then
-			.. " ('upright' cannot be used in conjunction with height or width)",
+			error(string.format(
-			methodName
+				"duplicate size argument detected in '%s' ('upright' cannot be"
-		), 3)
+					.. ' used in conjunction with height or width)',
 	end
-−
 	function data:width(px)
 		checkSelf(self, 'width')
-		checkType('fileLink:width', 1, px, 'number', true)
+		checkTypeStringOrNum('fileLink:width', 1, px)
-		if px and data.isUpright then
+		px = validateSize('fileLink:width', px)
-			sizeError('fileLink:width')
-		end
 		data.theWidth = px
 		return self
@@ Line 73: / Line 107: @@
 	function data:height(px)
 		checkSelf(self, 'height')
-		checkType('fileLink:height', 1, px, 'number', true)
+		checkTypeStringOrNum('fileLink:height', 1, px)
-		if px and data.isUpright then
+		px = validateSize('fileLink:height', px)
-			sizeError('fileLink:height')
-		end
 		data.theHeight = px
 		return self
@@ Line 185: / Line 217: @@
 		data.theLang = s
 		return self
 	end

@@ Line 184: / Line 184: @@
 		checkType('fileLink:lang', 1, s, 'string', true)
 		data.theLang = s
 		return self
 	end
@@ Line 236: / Line 269: @@
 		-- Render named parameters.
-		-- That includes link, alt, page, class, and lang.
+		-- That includes link, alt, page, class, lang, start, end, and thumbtime.
 		do
-			local namedParameters = {'link', 'alt', 'page', 'class', 'lang'}
+			local namedParameters = {
-			for i, parameter in ipairs(namedParameters) do
+				{'link', 'theLink'},
-				local dataField = 'the' .. parameter:sub(1, 1):upper() .. parameter:sub(2, -1)
+				{'alt', 'theAlt'},
-				local value = data[dataField]
+				{'page', 'thePage'},
 				if value then
 					ret[#ret + 1] = parameter .. '=' .. tostring(value)

@@ Line 23: / Line 23: @@
 	function data:name(s)
-		checkSelf(self, 'fileLink:name')
+		checkSelf(self, 'name')
 		checkType('fileLink:name', 1, s, 'string')
 		data.theName = s
@@ Line 30: / Line 30: @@
 	function data:format(s, filename)
-		checkSelf(self, 'fileLink:format')
+		checkSelf(self, 'format')
 		checkType('fileLink:format', 1, s, 'string', true)
 		checkType('fileLink:format', 2, format, 'string', true)
@@ Line 62: / Line 62: @@
 	function data:width(px)
-		checkSelf(self, 'fileLink:width')
+		checkSelf(self, 'width')
 		checkType('fileLink:width', 1, px, 'number', true)
 		if px and data.isUpright then
@@ Line 72: / Line 72: @@
 	function data:height(px)
-		checkSelf(self, 'fileLink:height')
+		checkSelf(self, 'height')
 		checkType('fileLink:height', 1, px, 'number', true)
 		if px and data.isUpright then
@@ Line 82: / Line 82: @@
 	function data:upright(isUpright, factor)
-		checkSelf(self, 'fileLink:upright')
+		checkSelf(self, 'upright')
 		checkType('fileLink:upright', 1, isUpright, 'boolean', true)
 		checkType('fileLink:upright', 2, factor, 'number', true)
@@ Line 94: / Line 94: @@
 	function data:resetSize()
-		checkSelf(self, 'fileLink:resetSize')
+		checkSelf(self, 'resetSize')
 		for i, field in ipairs{'theWidth', 'theHeight', 'isUpright', 'uprightFactor'} do
 			data[field] = nil
@@ Line 102: / Line 102: @@
 	function data:location(s)
-		checkSelf(self, 'fileLink:location')
+		checkSelf(self, 'location')
 		checkType('fileLink:location', 1, s, 'string', true)
 		local validLocations = {
@@ Line 122: / Line 122: @@
 	function data:alignment(s)
-		checkSelf(self, 'fileLink:alignment')
+		checkSelf(self, 'alignment')
 		checkType('fileLink:alignment', 1, s, 'string', true)
 		local validAlignments = {
@@ Line 146: / Line 146: @@
 	function data:border(hasBorder)
-		checkSelf(self, 'fileLink:border')
+		checkSelf(self, 'border')
 		checkType('fileLink:border', 1, hasBorder, 'boolean', true)
 		data.hasBorder = hasBorder
@@ Line 153: / Line 153: @@
 	function data:link(s)
-		checkSelf(self, 'fileLink:link')
+		checkSelf(self, 'link')
 		checkType('fileLink:link', 1, s, 'string', true)
 		data.theLink = s
@@ Line 160: / Line 160: @@
 	function data:alt(s)
-		checkSelf(self, 'fileLink:alt')
+		checkSelf(self, 'alt')
 		checkType('fileLink:alt', 1, s, 'string', true)
 		data.theAlt = s
@@ Line 167: / Line 167: @@
 	function data:page(num)
-		checkSelf(self, 'fileLink:page')
+		checkSelf(self, 'page')
 		checkType('fileLink:page', 1, num, 'number', true)
 		data.thePage = s
@@ Line 174: / Line 174: @@
 	function data:class(s)
-		checkSelf(self, 'fileLink:class')
+		checkSelf(self, 'class')
 		checkType('fileLink:class', 1, s, 'string', true)
 		data.theClass = s
@@ Line 181: / Line 181: @@
 	function data:lang(s)
-		checkSelf(self, 'fileLink:lang')
+		checkSelf(self, 'lang')
 		checkType('fileLink:lang', 1, s, 'string', true)
 		data.theLang = s
@@ Line 188: / Line 188: @@
 	function data:caption(s)
-		checkSelf(self, 'fileLink:caption')
+		checkSelf(self, 'caption')
 		checkType('fileLink:caption', 1, s, 'string', true)
 		data.theCaption = s
@@ Line 195: / Line 195: @@
 	function data:render()
-		checkSelf(self, 'fileLink:render')
+		checkSelf(self, 'render')
 		local ret = {}

@@ Line 84: / Line 84: @@
 		wrappers = 'Template:File link'
 	})
 	-- Copy the arguments that were passed to a new table to avoid looking up
 	-- every possible parameter in the frame object.

← Older revision	Revision as of 11:49, 8 April 2016
(No difference)

@@ Line 1: / Line 1: @@
 -- This module provides a library for formatting file wikilinks.
 local checkType = require('libraryUtil').checkType
@@ Line 57: / Line 58: @@
 	end
-	addPositional('border')
+	-- Border
 	addPositional('location')
 	addPositional('alignment')

← Older revision	Revision as of 08:57, 3 June 2014
(No difference)