Module:Gallery

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

-- This module implements {{gallery}}

local p = {}

local templatestyles = 'Template:Gallery/styles.css'

local function trim(s)
	return (mw.ustring.gsub(s, "^%s*(.-)%s*$", "%1"))
end

local tracking, preview = '', ''

local function checkarg(k)
	if k and type(k) == 'string' then
		if k == 'align' or k == 'state' or k == 'style' or k == 'title' or
			k == 'width' or k == 'height' or k == 'lines' or 
			k == 'footer' or k == 'perrow' or
			k:match('^alt%d+$') or k:match('^%d+$') then
			-- valid
		elseif k == 'cellwidth' then
			tracking = tracking .. '[[Category:Pages using gallery with the cellwidth parameter]]'
		elseif k == 'captionstyle' then
			tracking = tracking .. '[[Category:Pages using gallery with the captionstyle parameter]]'
		elseif k:match('^width%d+$') then
			-- deprecated
			k = mw.ustring.gsub(k, '^width(%d+)$', '%1')
			tracking = tracking .. '[[Category:Pages using gallery with custom width parameters|' .. k .. ']]'
		else
			-- invalid
			local vlen = mw.ustring.len(k)
			k = mw.ustring.sub(k, 1, (vlen < 25) and vlen or 25) 
			k = mw.ustring.gsub(k, '[^%w\-_ ]', '?')
			tracking = tracking .. '[[Category:Pages using gallery with unknown parameters|' .. k .. ']]'
			preview = preview .. 'Unknown: "' .. k .. '"<br>'
		end
	end
	return t
end

function p.gallery(frame)
	-- If called via #invoke, use the args passed into the invoking template.
	-- Otherwise, for testing purposes, assume args are being passed directly in.
	local origArgs = (type(frame.getParent) == 'function') and frame:getParent().args or frame
    
    -- ParserFunctions considers the empty string to be false, so to preserve the previous 
    -- behavior of {{gallery}}, change any empty arguments to nil, so Lua will consider
    -- them false too.
    local args = {}
    for k, v in pairs(origArgs) do
    	if v ~= '' then
    		args[k] = v
    		checkarg(k)
    	end
	end

	local tbl = mw.html.create('div'):css('display', 'table')
	tbl:addClass('mw-module-gallery')
    
	if args.state then
		tbl
			:css('width', '100%')
			:addClass('collapsible')
			:addClass(args.state)
	end
	
	if args.style then
		tbl:cssText(args.style)
	else
		tbl
			:css('background', 'transparent')
			:css('margin-top', '0.5em')
	end
	
	if args.align then
		if args.align == 'center' then
			tbl
				:css('margin-left', 'auto')
				:css('margin-right', 'auto')
		else
			tbl:css('float', args.align)
		end
	end
	
	if args.title then
		tbl
			:tag('div'):css('display', 'table-row')
				:tag('div'):css('display', 'table-cell')
					:css('text-align', 'center')
					:css('font-weight', 'bold')
					:wikitext(args.title)
	end
	
	local mainCell = tbl:tag('div'):css('display', 'table-row'):tag('div'):css('display', 'table-cell')
	
	local imageCount = math.ceil(#args / 2)
	local cellWidth = tonumber(args.cellwidth) or tonumber(args.width) or 180
	local imgHeight = tonumber(args.height) or 180
	local lines = tonumber(args.lines) or 2
	local captionstyle = args.captionstyle
	
    for i = 1, imageCount do
		local img = trim(args[i*2 - 1] or '')
		local caption = trim(args[i*2] or '')
		local imgWidth = tonumber(args['width' .. i]) or tonumber(args.width) or 180
		local alt = args['alt' .. i] or ''
		
		local textWidth
		if cellWidth < 30 then
			textWidth = imgHeight + 27
		else
			textWidth = cellWidth + 7
		end

		if img ~= '' then
			local imgTbl = mainCell:tag('div'):css('display', 'table')
            
			imgTbl
				:css('width', (cellWidth + 20) .. 'px')
				:css('float', 'left')
				:css('border-collapse', 'collapse')
				:css('margin', '3px')
				:tag('div'):css('display', 'table-row')
					:tag('div'):css('display', 'table-cell')
						:css('height', (imgHeight + 20) .. 'px')
						:css('border', '1px solid #CCCCCC')
						:css('background-color', '#F8F8F8')
						:css('padding', '0px')
						:css('text-align', 'center')
						:css('vertical-align', 'middle')
						:wikitext(string.format('[[%s|center|border|%dx%dpx|alt=%s|%s]]', img, imgWidth, imgHeight, alt, mw.text.unstrip(caption)))
						:done()
					:done()
				:tag('div'):css('display', 'table-row')
					:css('vertical-align', 'top')
					:tag('div'):css('display', 'table-cell')
						:css('display', 'block')
						:css('font-size', '94%')
						:css('padding', '0px')
						:tag('div')
							:addClass('gallerytext')
							:css('min-height', (0.1 + 1.5*lines) .. 'em')
							:css('width', textWidth .. 'px')
							:css('line-height', '1.3em')
							:css('padding', '2px 6px 1px 6px')
							:css('margin', '0px')
							:css('border', 'none')
							:css('border-width', '0px')
							:cssText(captionstyle)
							:wikitext(caption .. '&nbsp;')
		end
	end
    
	if args.footer then
		tbl
			:tag('div'):css('display', 'table-row')
				:tag('div'):css('display', 'table-cell')
					:css('text-align', 'right')
					:css('font-size', '80%')
					:css('line-height', '1em')
					:wikitext(args.footer)
	end
	if args.perrow then
		tbl:css('width', 8 + (cellWidth + 20 + 6)*tonumber(args.perrow) .. 'px')
	end

	if preview ~= '' then
		if frame:preprocess( "{{REVISIONID}}" ) == "" then
			tracking = preview
		end
	end
	
	return frame:extensionTag{ name = 'templatestyles', args = { src = templatestyles} } .. tostring(tbl) .. tracking
end

return p