Module:Unsubst-infobox

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

Usage

{{SAFESUBST:<noinclude />#invoke:Unsubst-infobox||$B=template body|$params=parameters}}

Infoboxes should never be substituted. A trick to avoid that is to make a template substitute to its transcluded form. This module is similar to Module:Unsubst. parameters is a comma-separated list of the names of parameters the invoking infobox template can take.

Parameter list

$B

The content of the template, as it would be without the module being used.

$params

A comma-separated list of template parameters, without any aliases. There is a bug when including positional parameters like $params=1 in the template and {{subst:example|a}} in the article where it will be overwritten like {{subst:example|a|1=}}.

$aliases

A comma-separated list of parameter replacements, in the format old1>new1,old2>new2. There is a bug when including positional parameters like |$aliases=2>details|$params=details in the template and {{subst:example|abc|def|ghi}} in the article where there is an inconsistency that causes data to be lost like {{subst:example|abc|details=def}}

$set3

Usually a shorter list of parameters, comma-separated. Replaces $params when all the parameters used in a substitution (ignoring those erroneously absent from $params) are in this list. This might be used if an infobox has multiple parameters that are only applicable to some group of articles.

$set2

Conditionally replaces $set3 or $params, whichever was last chosen. Usually bigger than them.

$set1

Conditionally replaces $set3, $set2 or $params, whichever was last chosen. Usually bigger than them.

$extra

A comma-separated list of any parameters listed in $params (or $set1, $set2, or $set3, whichever was chosen) which don't need to be shown after substitution unless they are already being used in the template; i.e. if a parameter is in both lists and is not used or blank in a particular transclusion, then on substitution the parameter will not be displayed.

$indent

The number of additional spaces before each line. Useful for child infoboxes.

$flags

A list of comma-separated flags. The only valid input for this parameter at present is "override", which tells the template to supersede the original input to the template with any parameters which are set in the module; i.e. if the template transclusion uses |number=6 but the module invocation uses |date=7, if the module invocation contains override in |$flags= then the output will be |date=7 and if it doesn't then the output will be |date=6.

$template-name

May be used to override the default template name.

All other parameters are treated as input to the template. If the input value is not blank and the input parameter is a valid parameter of the template, then the value will appear in the post-substitution content if the transclusion's value is blank; if the module invocation contains override in |$flags= then the value will appear in the post-substitution content regardless of what the transclusion's value is.

The above documentation is transcluded from Module:Unsubst-infobox/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (create) pages.
Subpages of this module.

local p = {}

local specialParams = {
	['$P'] = 'parameters',
	['$E'] = 'extra parameters',
	['$U'] = 'usual parameters',
	['$A'] = 'aliases',
	['$B'] = 'template content'
}

p[''] = function ( frame )
	if not frame:getParent() then
		error( '{{#invoke:Unsubst-infobox|}} makes no sense without a parent frame' )
	end
	if not frame.args['$B'] then
		error( '{{#invoke:Unsubst-infobox|}} requires parameter $B (template content)' )
	end
	if not frame.args['$P'] then
		error( '{{#invoke:Unsubst-infobox|}} requires parameter $P (parameter list)' )
	end
	
	if mw.isSubsting() then
		---- substing
		-- Combine passed args with passed defaults
		local args = {}
		for k, v in pairs( frame.args ) do
			if not specialParams[k] then
				if v == '__DATE__' then
					v = mw.getContentLanguage():formatDate( 'F Y' )
				end
				args[k] = v
			end
		end
		for k, v in pairs( frame:getParent().args ) do
			args[k] = v
		end

		-- Build an equivalent template invocation
		-- First, find the title to use
		local titleobj = mw.title.new(frame:getParent():getTitle())
		local title
		if titleobj.namespace == 10 then -- NS_TEMPLATE
			title = titleobj.text
		elseif titleobj.namespace == 0 then -- NS_MAIN
			title = ':' .. titleobj.text
		else
			title = titleobj.prefixedText
		end

		-- Build the invocation body with numbered args first, then named
		local ret = '{{' .. title
		for k, v in ipairs( args ) do
			if string.find( v, '=', 1, true ) then
				-- likely something like 1=foo=bar, we need to do it as a named arg
				break
			end
			if not aliases[k] then
				ret = ret .. '|' .. v
				args[k] = nil
			end
		end
		
		-- Pull lists from special parameters
		local params = mw.text.split( frame.args['$P'], '%s*,%s*' )
		local usual, extra = {}, {}
		if frame.args['$U'] then
			local tmp = mw.text.split( frame.args['$U'], '%s*,%s*' )
			for k, v in ipairs( tmp ) do usual[v] = true end
		elseif frame.args['$E'] then
			local tmp = mw.text.split( frame.args['$E'], '%s*,%s*' )
			for k, v in ipairs( tmp ) do extra[v] = true end
		end
		local aliases = {}
		if frame.args['$A'] then
			for k, v in ipairs( mw.text.split( frame.args['$A'], '%s*,%s*' ) ) do
				local tmp = mw.text.split( v, '%s*=%s*' )
				aliases[tmp[1]] = aliases[tmp[2]]
			end
		end
		
		-- Pull information from parameter aliases
		for k, v in pairs( args ) do
			if aliases[k] and ((not args[aliases[k]]) or args[aliases[k]] == '') then args[aliases[k]] = v end
		end
		
		-- Replace parameter list with short version if full version not necessary
		local tmp = 0
		if #usual > 0 then
			for k, v in pairs( args ) do
				if not usual[k] then
					tmp = 1
					break
				end
			end
		else
			tmp = 1
		end
		if tmp == 0 then params = usual end
		
		-- Indent parameters correctly
		local maxlength = 0
		for k, v in ipairs( params ) do
			local tmp = mw.ustring.len( v )
			if tmp > maxlength then maxlength = tmp end
		end
		
		for k, v in ipairs( params ) do
			if not extra[k] or (args[v] and args[v] ~= '') then
				ret = ret .. '\n| ' .. v .. string.rep(' ', (maxlength - mw.ustring.len( v ))) .. ' = ' .. (args[v] or '')
			end
		end
	
		ret = ret .. '\n}}'
		
		ret = mw.ustring.gsub(ret, '%s+\n', '\n')
		
		return ret
	else
		-- Not substing
		-- Just return the "body"
		return frame.args['$B']
	end
end

return p