Module:Random slideshow/sandbox

Module documentation[view] [edit] [history] [purge]

Usage

{{#invoke:Random slideshow|main}}

See {{Random slideshow}} for details.

{{#invoke:Random slideshow|transclude}}

See {{Transclude files as random slideshow}} for details.

This module is also used by Module:Excerpt slideshow.

Display in the mobile view

On mobile devices, a standard gallery is displayed instead of the slideshow. If the screen width is less than 720px, only the first four images after randomisation are visible (example screenshot). For mobile devices with larger resolutions, all images are displayed (example screenshot). For some tables, it displays all images stacked (example screenshot).

Testcases

The following testcase pages are available for testing changes made to this module's sandbox:

• Template:Random slideshow/testcases
• Template:Transclude files as random slideshow/testcases

The above documentation is transcluded from Module:Random slideshow/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this module.

-- Creates a slideshow gallery where the order is randomised. Intended for use on portal pages.
local p = {}

local randomModule = require('Module:Random')

function cleanupArgs(argsTable)
	local cleanArgs = {}
	for key, val in pairs(argsTable) do
		if type(val) == 'string' then
			val = val:match('^%s*(.-)%s*$')
			if val ~= '' then
				cleanArgs[key] = val
			end
		else
			cleanArgs[key] = val
		end
	end
	return cleanArgs
end

function makeOutput(galleryLines, maxWidth)
	local randomiseArgs = {	['t'] = galleryLines }
	local randomisedLines = randomModule.main('array', randomiseArgs)
	local galleryContent = table.concat(randomisedLines, '\n')
	local output = '<div style="max-width:' .. maxWidth .. 'px; margin:-4em auto;">{{#tag:gallery|' .. galleryContent  .. '|mode=slideshow}}</div>'
	return output
end

function makeGalleryLine(file, caption)
	local title = mw.title.new(file, "File" )
	return title.prefixedText .. '{{!}}' .. (caption or '')
end

function makeGalleryLinesTable(args)
	local galleryLinesTable = {}
	local i = 1
	while args[i] do
		table.insert(galleryLinesTable, makeGalleryLine(args[i], args[i+1]))
		i = i + 2
	end
	return galleryLinesTable 
end

p.main = function(frame)
	local parent = frame.getParent(frame)
	local parentArgs = parent.args
	local args = cleanupArgs(parentArgs)
	if not args[1] then
		return error('No files specified', 0)
	end
	local lines = makeGalleryLinesTable(args)
	local output = makeOutput(lines, args.width or '350')
	return frame:preprocess(output)
end

return p