Module:Parameter names example: 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.
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(args, frame)
	-- Find how we want to format the arguments to the template.
	local formatFunc
	if args._display == 'italics' or args._display == 'italic' then
		formatFunc = italicize
	else
		formatFunc = makeParam
	end

	-- Build the table of template arguments.
	local targs = {}
	for k, v in pairs(args) do
		if type(k) == 'number' then
			targs[v] = formatFunc(v)
		elseif not k:find('^_') then
			targs[k] = v
		end
	end

	-- Find the template name and call it with the arguments.
	local template = args._template or mw.title.getCurrentTitle().basePageTitle.text
	frame = frame or mw.getCurrentFrame()
	return frame:expandTemplate{title = template, args = targs}
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