Module:File link

This module is used to construct wikitext links to files. It is primarily useful for templates and modules that use complicated logic to make file links. Simple file links should be made with wikitext markup directly, as it uses less resources than calling this module. For help with wikitext file markup please refer to the documentation at mediawiki.org.

Usage from wikitext

From wikitext, this module should be called from a template, usually {{file link}}. Please see the template page for documentation. However, it can also be called using the syntax {{#invoke:File link|main|arguments}}.

Usage from Lua

First, you need to import the module.

local mFileLink = require('Module:File link')

Then you can make file links using the _main function.

mFileLink._main(args)

args is a table of arguments that can have the following keys:

• file - the filename. (required)
• format - the file format, e.g. 'thumb', 'thumbnail', 'frame', 'framed', or 'frameless'.
• formatfile - a filename to specify with the 'thumbnail' format option. The filename specified will be used instead of the automatically generated thumbnail.
• border - set this to true or "yes" (or any other value recognized as true by Module:Yesno) to set a border for the image.
• location - the horizontal alignment of the file, e.g. 'right', 'left', 'center', or 'none'.
• alignment - the vertical alignment of the file, e.g. 'baseline', 'middle', 'sub', 'super', 'text-top', 'text-bottom', 'top', or 'bottom'.
• size - the size of the image, e.g. '100px', 'x100px' or '100x100px'.
• upright - the 'upright' parameter, used for setting the size of tall and thin images.
• link - the page that the file should link to. Use the blank string '' to suppress the default link to the file description page.
• alt - the alt text. Use the blank string '' to suppress the default alt text.
• caption - a caption for the file.
• page - sets a page number for multi-paged files such as PDFs.
• class - adds a class parameter to image links. The MediaWiki software adds this parameter to the class="..." attribute of the image's <img /> element when the page is rendered into HTML.
• lang - adds a language attribute to specify what language to render the file in.
• start - specifies a start time for audio and video files.
• end - specifies an end time for audio and video files.
• thumbtime - specifies the time to use to generate the thumbnail image for video files.

To see the effect of each of these parameters, see the images help page on mediawiki.org.

Examples

With the file only:

mFileLink.main{file = 'Example.png'}
-- Renders as [[File:Example.png]]

With format, size, link and caption options:

mFileLink.main{
	file = 'Example.png',
	format = 'thumb',
	size = '220px',
	link = 'Wikipedia:Sandbox',
	caption = 'An example.'
}
-- Renders as [[File:Example.png|thumb|220px|link=Wikipedia:Sandbox|An example.]]

With format, size, and border:

mFileLink.main{
	file = 'Example.png',
	format = 'frameless',
	size = '220px',
	border = true
}
-- Renders as [[File:Example.png|frameless|border|220px]]

---

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

local libraryUtil = require('libraryUtil')

local image = {}

function image.new()
	local obj, data = {}, {}
	
	local checkSelf = libraryUtil.makeCheckSelfFunction('image', 'image', obj, 'image object')
	local checkType = libraryUtil.checkType
	
	function data:name(s)
		checkSelf(self, 'name')
		checkType('name', 1, s, 'string')
		data.theName = s
	end
	
	function data:format(s, filename)
		checkSelf(self, 'format')
		checkType('format', 1, s, 'string')
		checkType('format', 2, format, 'string', true)
		local validFormats = {
			thumb = true,
			thumbnail = true,
			frame = true,
			framed = true,
			frameless = true
		}
		if validFormats[s] then
			data.theFormat = s
			data.theFormatFilename = filename
		else
			error('invalid format')
		end
	end
	
	function data:width(px)
		checkSelf(self, 'width')
		checkType('width', 1, px, 'number')
		data.theWidth = px
	end
	
	function data:height(px)
		checkSelf(self, 'height')
		checkType('height', 1, px, 'number')
		data.theHeight = px
	end
	
	function data:upright(factor)
		checkSelf(self, 'upright')
		checkType('upright', 1, factor, 'number', true)
		data.isUpright = true
		data.uprightFactor = factor
	end
	
	function data:resetSize()
		checkSelf(self, 'resetSize')
		for i, field in ipairs{'theWidth', 'theHeight', 'isUpright', 'uprightFactor'} do
			data[field] = nil
		end
	end
	
	function data:location(s)
		checkSelf(self, 'location')
		checkType('location', 1, s, 'string')
		local validLocations = {
			right = true,
			left = true,
			center = true,
			none = true
		}
		if validLocations[s] then
			data.theLocation = s
		else
			error(string.format(
				"bad argument #1 to 'location' ('%s' is not a valid location)",
				s
			))
		end
	end
	
	function data:alignment(s)
		checkSelf(self, 'alignment')
		checkType('alignment', 1, s, 'string')
		local validAlignments = {
			baseline = true,
			middle = true,
			sub = true,
			super = true,
			['text-top'] = true,
			['text-bottom'] = true,
			top = true,
			bottom = true
		}
		if validAlignments[s] then
			data.theAlignment = s
		else
			error(string.format(
				"bad argument #1 to 'alignment' ('%s' is not a valid alignment)"
			))
		end
	end
	
	function data:border()
		checkSelf(self, 'border')
		data.hasBorder = true
	end
	
	function data:link(s)
		checkSelf(self, 'link')
		checkType('link', 1, s, 'string')
		data.theLink = s
	end
	
	function data:alt(s)
		checkSelf(self, 'alt')
		checkType('alt', 1, s, 'string')
		data.theAlt = s
	end
	
	function data:caption(s)
		checkSelf(self, 'caption')
		checkType('caption', 1, s, 'string')
		data.theCaption = s
	end
	
	function data:render()
		checkSelf(self, 'render')
		local ret = {}
		
		-- Image name.
		if not data.theName then
			error('image:render: no image name was found')
		end
		ret[#ret + 1] = 'File:' .. data.theName
		
		-- Image format
		if data.theFormat and data.theFormatFilename then
			ret[#ret + 1] = data.theFormat .. '=' .. data.theFormatFilename
		elseif data.theFormat then
			ret[#ret + 1] = data.theFormat
		end
		
		-- Border
		if data.hasBorder then
			ret[#ret + 1] = 'border'
		end
		
		-- Location
		ret[#ret + 1] = data.theLocation

		-- Alignment
		ret[#ret + 1] = data.theAlignment
		
		-- Size
		if data.isUpright and (data.theWidth or data.theHeight) then
			error("duplicate size value detected in 'render' (height/width cannot be used at the same time as 'upright')")
		elseif data.isUpright and data.uprightFactor then
			ret[#ret + 1] = 'upright=' .. tostring(data.uprightFactor)
		elseif data.isUpright then
			ret[#ret + 1] = 'upright'
		elseif data.theWidth and data.theHeight then
			ret[#ret + 1] = string.format('%dx%dpx', data.theWidth, data.theHeight)
		elseif data.theWidth then
			ret[#ret + 1] = tostring(data.theWidth) .. 'px'
		elseif data.theHeight then
			ret[#ret + 1] = string.format('x%dpx', data.theHeight)
		end
		
		-- Link
		if data.theLink then
			ret[#ret + 1] = 'link=' .. data.theLink
		end
		
		-- Alt
		if data.theAlt then
			ret[#ret + 1] = 'alt=' .. data.theAlt
		end
		
		-- Caption
		ret[#ret + 1] = data.theCaption
		
		return string.format('[[%s]]', table.concat(ret, '|'))
	end
	
	local readOnlyFields = {
		theName = true,
		theFormat = true,
		theFormatFilename = true,
		theWidth = true,
		theHeight = true,
		isUpright = true,
		uprightFactor = true,
		theLocation = true,
		theAlignment = true,
		hasBorder = true,
		theLink = true,
		theAlt = true,
		theCaption = true
	}
	for field in pairs(data) do
		readOnlyFields[field] = true
	end
	
	setmetatable(obj, {
		__index = data,
		__newindex = function (t, key, value)
			if readOnlyFields[key] then
				error(string.format(
					"field '%s' is read-only",
					tostring(key)
				), 2)
			else
				data[key] = value
			end
		end,
		__tostring = function (t)
			return t:render()
		end
	})
	
	return obj
end

return image