Module:Unsubst-infobox/doc

This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing.

This Lua module is used on approximately 208,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.

{{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.

$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.