Template:Always substitute/doc: Difference between revisions

Latest revision as of 13:35, 11 December 2024

Do not substitute this template. To use this template, transclude it in an article with the following wikitext: {{Always substitute}}. The template's content will then dynamically appear in the article, reflecting updates made to the template itself.

Use {{Always substitute}} at the top of the documentation for a template that must be substituted.

{{Always substitute}} →

Always substitute this template. To use this template, include the following wikitext in an article: {{subst:Always substitute}}. After saving, the template's content will permanently replace the template call, and you can edit it as needed.

TemplateData

This template creates a notice on a template's documentation telling editors that the template should be substituted.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
No parameters specified

@@ Line 1: / Line 1: @@
-{{tsh|subst only}}
+{{Never substitute}}
-{{never substitute}}
+Use {{tlx|Always substitute}} at the top of the documentation for a template that must be [[MW:Substitution|substituted]].
-{{high-use}}
-{{doc sub}}
-<!--- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE --->
-{{tlf|Always substitute}} produces the following notice:
-<div style="padding-top:0.5em;padding-bottom:0.6em;">{{Subst only|actualtemplate={{tlg|foo|subst=on}}}}</div>
-(but {{tlf|Always substitute}} itself should '''''not''''' be [[Help:Substitution|substituted]].)
-=== Usage ===
+* {{tlx|Always substitute}} →
-<code><nowiki>{{Always substitute}}</nowiki></code>
+{{Always substitute}}
-{{tlf|Always substitute}} should be placed on the {{strong|[[Wikipedia:Template documentation|documentation]] [[Wikipedia:Subpage|subpage]]}} of any template that requires [[Help:Substitution|substitution]] rather than [[Wikipedia:Transclusion|transclusion]] (i.e. not on the template's own page itself).
+== TemplateData ==
+<templatedata>
-Pages that include {{tlf|Always substitute}} are added to [[:Category:Wikipedia substituted templates]].
+{
+	"params": {},
-=== Parameters ===
+	"description": "This template creates a notice on a template's documentation telling editors that the template should be substituted.",
-{{para|auto}}
+	"format": "inline"
-: If set as "yes", the template to which the notice refers will be subst:ed automatically unless the {{para|demo|yes}} parameter is set. The notice is amended to state this. Default is "no". Setting this parameter to "yes" places the template in {{cl|Wikipedia templates to be automatically substituted}}; see [[User:AnomieBOT/docs/TemplateSubster]] for more information.
+}
-{{para|alt}}
+</templatedata>
-: Use to set an alternate and transcludable name for the template.
-== Redirects ==
-* {{tl|substed}}
-* {{tl|substitute}}
-* {{tl|substituted}}
-* {{tl|substonly}}
-* {{tl|subst only}}
-{{List of subst helper templates}}
-<includeonly>{{sandbox other||
-<!--- CATEGORIES HERE, PLEASE: --->
-{{DEFAULTSORT:Substitute, Always}}
-[[Category:Documentation header templates]]
-}}</includeonly>

Template:Always substitute/doc: Difference between revisions

Latest revision as of 13:35, 11 December 2024

TemplateData

Navigation menu

Search