Difference between revisions of "Template:Nosubst/doc"
Sarna News
m (Text replacement - "<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>" to "{{Documentation subpage}}") |
m (Updating) |
||
| Line 1: | Line 1: | ||
| − | |||
{{Documentation subpage}} | {{Documentation subpage}} | ||
| − | <!-- | + | <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> |
| − | {{ | + | {{hatnote|The following also '''applies''' to this template, so this template should '''never''' be substituted:}} |
| + | {{Never substitute}} | ||
| − | This template | + | === Usage === |
| − | <includeonly> | + | <code><nowiki>{{Never substitute}}</nowiki></code> |
| − | <!-- | + | |
| − | [[Category: | + | This template should be placed on the <big>[[Template:Documentation|documentation]] [[Template:Documentation subpage|subpage]]</big> (not the template page itself) of any template that should '''not''' be substituted (and [[Help:Transclusion|transcluded]] instead). |
| − | + | ||
| − | </includeonly> | + | '''Parameters''' |
| + | * This template accepts one optional parameter, which can be used to give a more detailed description of why the template in question should not be substituted. For example, <code><nowiki>{{Never substitute|Example text.}}</nowiki></code> produces: | ||
| + | {{Never substitute|Example text.}} | ||
| + | |||
| + | {{List of subst helper templates}} | ||
| + | |||
| + | <includeonly>{{sandbox other|| | ||
| + | <!-- Categories below this line, please; interwikis at Wikidata --> | ||
| + | {{DEFAULTSORT:Substitute, Never}} | ||
| + | [[Category:Documentation header templates]] | ||
| + | |||
| + | }}</includeonly> | ||
Latest revision as of 21:37, 30 April 2023
 | This is a documentation subpage for Template:Nosubst. It may contain usage information, categories and other content that is not part of the original template page. |
 | Please do not substitute this template. |
Usage[edit]
{{Never substitute}}
This template should be placed on the documentation subpage (not the template page itself) of any template that should not be substituted (and transcluded instead).
Parameters
- This template accepts one optional parameter, which can be used to give a more detailed description of why the template in question should not be substituted. For example,
{{Never substitute|Example text.}}produces:
| Please do not substitute this template. Example text. |
List of subst helper templates[edit]
- {{require substitution}} – Prints an error unless substituted.
- {{always substitute}} – For the Template documentation of the above templates; prints a message asking for it be substituted.
- {{never substitute}} – The reverse of {{always substitute}}. For the doc of templates which should not be substituted; prints a message asking for it not to be substituted.
- {{may be substituted}} – For the doc of templates whose substitution is optional.
- {{substitution}} – Allows free-fill description of whether the template should be substituted and under what conditions.
- {{ifsubst}} – Forks if substituted or not.
- {{issubst}} – Returns "yes" if substituted.
- Module:Unsubst – Prevents substitution.
- Module:Unsubst-infobox – Prevents substitution for infoboxes, cleans up parameters.