![]() | This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
![]() | This Lua module is used on
approximately 196,000 pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
{{#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.
old1>new1,old2>new2
.|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
.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.
local p = {}
local specialParams = {
'$params' = 'all parameters',
'$extra' = 'extra parameters',
'$set1' = 'parameter set 1',
'$set2' = 'parameter set 2',
'$set3' = 'parameter set 3',
'$aliases' = 'parameter aliases',
'$indent' = 'indent',
'$flags' = 'flags',
'$B' = 'template content',
'$template-name' = 'template invocation name override'
}
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'$params' then
error( '{{#invoke:Unsubst-infobox|}} requires parameter $params (parameter list)' )
end
if mw.isSubsting() then
---- substing
-- Combine passed args with passed defaults
local args = {}
if string.find( ','..(frame.args'$flags' or '')..',', ',%s*override%s*,' ) then
for k, v in pairs( frame:getParent().args ) do
argsk = v
end
for k, v in pairs( frame.args ) do
if not specialParamsk then
if v == '__DATE__' then
v = mw.getContentLanguage():formatDate( 'F Y' )
end
argsk = v
end
end
else
for k, v in pairs( frame.args ) do
if not specialParamsk then
if v == '__DATE__' then
v = mw.getContentLanguage():formatDate( 'F Y' )
end
argsk = v
end
end
for k, v in pairs( frame:getParent().args ) do
argsk = v
end
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
if frame.args'$template-name' and '' ~= frame.args'$template-name' then
title = frame.args'$template-name' -- override whatever the template name is with this name
end
-- Remove empty fields
for k, v in pairs( args ) do
if v == '' then argsk = nil end
end
-- Pull information from parameter aliases
local aliases = {}
if frame.args'$aliases' then
local list = mw.text.split( frame.args'$aliases'], '%s*,%s*' )
for k, v in ipairs( list ) do
local tmp = mw.text.split( v, '%s*>%s*' )
aliases[(tonumber(mw.ustring.match(tmp1], '^[1-9][0-9]*$'))) or tmp1]] = ((tonumber(mw.ustring.match(tmp2], '^[1-9][0-9]*$'))) or tmp2])
end
end
for k, v in pairs( aliases ) do
if argsk and not argsv then argsv], argsk = argsk], nil end
end
-- Build the invocation body with numbered args first, then named
local ret = '{{' .. title
for k, v in ipairs( args ) do
if mw.ustring.find( v, '=', 1, true ) then
-- likely something like 1=foo=bar, we need to do it as a named arg
break
end
if not aliasesk then
ret = ret .. '|' .. v
argsk = nil
end
end
-- Pull lists from special parameters
local params = mw.text.split( frame.args'$params'], '%s*,%s*' )
for k, v in ipairs( params ) do
paramsk = (tonumber(mw.ustring.match(v, '^[1-9][0-9]*$'))) or v
end
local sets, setparams, extra = {{}, {}, {}}, {}, {}
for k = 1, 3 do
local v = frame.args'$set' .. k
if v then
setparamsk = mw.text.split( v, '%s*,%s*' )
for x, y in ipairs( setparamsk ) do
setparamsk][x = (tonumber(mw.ustring.match(y, '^[1-9][0-9]*$'))) or y
setsk][setparamsk][x]] = true
end
end
end
if frame.args'$extra' then
local tmp = mw.text.split( frame.args'$extra'], '%s*,%s*' )
for k, v in ipairs( tmp ) do extra[(tonumber(mw.ustring.match(v, '^[1-9][0-9]*$'))) or v = true end
end
-- Replace parameter list with short version if full version not necessary
local tmp = {}
for k, v in ipairs( sets ) do
if next(v) then -- if table v is not empty
for _, x in ipairs( params ) do
if argsx and not vx then
tmpk = true
break
end
end
if not tmpk then params = setparamsk end
end
end
-- Align parameters correctly and remove extra ones
local maxlength = 0
local discard = {}
for k, v in ipairs( params ) do
if (not extrav]) or argsv then
local tmp = mw.ustring.len( tostring( v ) )
if tmp > maxlength then maxlength = tmp end
else
table.insert( discard, 1, k )
end
end
for k, v in ipairs( discard ) do table.remove( params, v ) end
local indent = string.rep(' ', (tonumber(frame.args'$indent']) or 0))
local space, newline = ' ', '\n'
if not next(params) then space, newline = '', '' end
for k, v in ipairs( params ) do
local tmp = space
if mw.ustring.match( mw.ustring.sub( ( argsv or '' ) .. ' ', 1, 1 ), '[%*:;#]' ) then tmp = '\n' end
ret = ret .. newline .. indent .. '|' .. space .. v .. string.rep(' ', (maxlength - mw.ustring.len( v ))) .. space .. '=' .. tmp .. (argsv or '')
end
ret = ret .. newline .. '}}'
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