Module:Parameter names example/sandbox: Difference between revisions

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

{{{title}}}

{{{above}}}
{{{subheader}}}
{{{image}}} {{{caption}}}
{{{header1}}}
{{{label2}}}	{{{data2}}}
{{{label3}}}	{{{data3}}}
{{{below}}}

This module implements {{Parameter names example}} (also known as {{Generic template demo}}). It creates a template demonstration such as that shown opposite. Please see the template page for full documentation.

The above documentation is transcluded from Module:Parameter names example/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.

-- This module implements {{parameter names example}}.

local p = {}

local function makeParam(s)
	local lb = '{'
	local rb = '}'
	return lb:rep(3) .. s .. rb:rep(3)
end

local function italicize(s)
	return "''" .. s .. "''"
end

function p._main(origArgs, frame)
	frame = frame or mw.getCurrentFrame()

	-- Separate the args and the options.
	local args, options = {}, {}
	for k, v in pairs(origArgs) do
		if type(k) == 'number' or not k:find('^_') then
			args[k] = v
		else
			options[k:gsub('^_', '')] = v
		end
	end

	-- Find how we want to format the arguments to the template.
	local formatFunc
	if options.display == 'italics' or options.display == 'italic' then
		formatFunc = italicize
	else
		formatFunc = makeParam
	end

	-- Build the table of template arguments, and record whether any named
	-- arguments are being used.
	local targs = {}
	local hasNamedArgs = false
	for k, v in pairs(args) do
		if type(k) == 'number' then
			targs[v] = formatFunc(v)
		else
			hasNamedArgs = true
			targs[k] = v
		end
	end

	-- Find the template name.
	local templateName
	if options.template then
		templateName = options.template
	else
		-- Find the title object for the template.
		local templateTitle
		local currentTitle = mw.title.getCurrentTitle()
		if currentTitle.prefixedText:find('/sandbox$') then
			templateTitle = currentTitle
		else
			templateTitle = currentTitle.basePageTitle
		end

		-- Format the template name according to the namespace we are in.
		if templateTitle.namespace == 10 then -- NS_TEMPLATE
			templateName = templateTitle.text
		elseif templateTitle.namespace == 0 then -- NS_MAIN
			templateName = ':' .. templateTitle.text
		else
			templateName = templateTitle.prefixedText
		end
	end

	local ret = ''

	-- Build the template invocation.
	if options.code then
		local code = { templateName }
		if hasNamedArgs then
			-- Put the args into alphabetical order.
			local keys = {}
			for k in pairs(targs) do
				keys[#keys + 1] = k
			end
			table.sort(keys, function (a, b)
				local typeA = type(a)
				local typeB = type(b)
				if typeA ~= typeB then
					return typeA == 'number' -- numbers go first
				else
					return a < b
				end
			end)

			-- Assemble the invocation.
			for _, k in ipairs(keys) do
				code[#code + 1] = ' ' .. tostring(k) .. ' = ' .. targs[k]
			end
		else
			-- Args are only numbers, but it is possible ipairs will not work
			-- if any of them use the "1 = foo" syntax, so sort them using
			-- pairs.
			local keys = {}
			for k in pairs(args) do
				keys[#keys + 1] = k
			end
			table.sort(keys)

			-- Assemble the invocation.
			for _, k in ipairs(keys) do
				code[#code + 1] = ' ' .. args[k] .. ' = ' .. targs[args[k]]
			end
		end

		code = '{{' .. table.concat(code, '\n|') .. '\n}}'
		code = '<pre style="white-space: pre-wrap;">\n' .. code .. '\n</pre>\n\n'
		ret = ret .. frame:preprocess(code)
	end

	-- Call the template with the arguments.
	local success, result = pcall(
		frame.expandTemplate,
		frame,
		{title = templateName, args = targs}
	)
	if success then
		ret = ret .. result
	end

	return ret
end

function p.main(frame)
	local args = require('Module:Arguments').getArgs(frame, {
		wrappers = 'Template:Parameter names example'
	})
	return p._main(args, frame)
end

return p