ވިކިޕީޑިއާ އިންވިކިޕީޑިއާ
Documentation icon Module documentation[view] [edit] [history] [purge]

Helper module to facilitate a substituted template transform into a template transclusion.

Maintenance templates, such as
{{Citation needed}} or

{{Refimprove}}, should never be substituted. A trick to avoid that is to make a template substitute to its transcluded form.

Usage[އުނިއިތުރު ގެންނަވާ]

To turn a template into a self-substituting template, wrap the existing template code with:

{{ {{{|safesubst:}}}#invoke:Unsubst||$N=TEMPLATENAME |$B=

 [ ... existing template code ... ]


The name of the template must be given as "$N", and the wikitext to display when not substed must be given as "$B".

All other parameters passed to the #invoke will be copied to the generated template invocation as default values. If the value of any of these default parameters is "__DATE__", that value in the generated template invocation will be the current month and year.

Example[އުނިއިތުރު ގެންނަވާ]

Consider a template Template:Example containing the following code:

{{ {{{|safesubst:}}}#invoke:Unsubst||$N=Example |foo=bar |date=__DATE__ |$B=

 [ ... Template code goes here ... ]

Original Result
{{subst:example}} {{Example|foo=bar|date=މާރޗް 2023}}
{{subst:example|foo=X}} {{Example|foo=X|date=މާރޗް 2023}}
{{subst:example|baz=X}} {{Example|foo=bar|baz=X|date=މާރޗް 2023}}
{{subst:example|date=January 2001}} {{Example|foo=bar|date=January 2001}}

local p = {}

local specialParams = {
	['$N'] = 'template name',
	['$B'] = 'template content',

p[''] = function ( frame )
	if not frame:getParent() then
		error( '{{#invoke:Unsubst|unsubst}} makes no sense without a parent frame' )
	for k, v in pairs( specialParams ) do
		if not frame.args[k] then
			error( '{{#invoke:Unsubst|unsubst}} requires parameter ' .. k .. ' (' .. v .. ')' )
	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' )
				args[k] = v
		for k, v in pairs( frame:getParent().args ) do
			args[k] = v

		-- Now, build an equivalent template invocation
		-- First numbered args, then named
		local ret = '{{' .. frame.args['$N']
		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
			ret = ret .. '|' .. v
			args[k] = nil
		for k, v in pairs( args ) do
			ret = ret .. '|' .. k .. '=' .. v
		return ret .. '}}'
		---- Not substing
		-- Just return the "body"
		return frame.args['$B']

return p