Template:Nosubst/doc

This documentation subpage contains instructions, categories, or other information for Template:Nosubst. [<Edit> Template:Nosubst]

[⧼Purge⧽ Template:Nosubst/doc]

This template should NOT be substituted.

The {{nosubst}} template itself should NOT be substituted! I hope this isn't too confusing...

The {{nosubst}} template should be placed on the documentation subpage (not the template page itself) of any template that should NOT be substituted (but transcluded instead) to show a notice as above.

Usage

{{nosubst}}

or

{{nosubst| reason }}

with parameters:

• reason: [optional] parameter which can be used to give a more detailed description of why the template in question should NOT be substituted.

Examples

The code

{{nosubst|Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.}}

yields

This template should NOT be substituted.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.