Module:Substcheck/doc

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:

The wikitext to display when not substed must be given as "$B". A parameter "$N" may also be seen in some templates; this was required in an older version of the module, but is no longer necessary and may be removed.

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.

Some templates have a but no matching at the end of the template. In such cases the missing must be added before the ending.

Example
Consider a template Template:Example containing the following code: