Template:Deprecated template/doc: Difference between revisions

[checked revision]

Content deleted Content added

Inline

Latest revision as of 13:23, 21 October 2020

Shortcuts

The {{Deprecated template}} template notifies users that a given template has been replaced by a different one or ones, or simply deprecated (advised to no longer be used) without a replacement. This is useful when usage is different (so a redirect won't work) or you'd like to reduce the number of redirects (which makes bot parsing more difficult).

Whenever possible, it should replace the deprecated template's content entirely, so that someone using the template will see only the message.

Usage

{{Deprecated template|old template name|new template name|date=April 2026}}

Usage without a second (replacement) template name simply produces:

Template:Deprecated template/doc is deprecated.

The template changes style depending on what kind of page it is shown on. Thus it adheres to the standardised looks for the different namespaces.

If a deprecated template is still in use on other pages, add <noinclude>...</noinclude> tags around the {{Deprecated template}} template. That way the template page will show the deprecation tag, but pages using it will not. If a template has been fully deprecated, meaning that it not in use on other pages, the noinclude tags may be removed. That way a deprecation tag will show on any page using the deprecated template. Afterwards consider nominating the template for deletion, or marking it with {{Historical template}}.

For more detail see wikipedia page wikipedia:Template:Deprecated template

@@ Line 5: / Line 5: @@
 {{tsh|Tdeprecated|TemplateObsolete|Deprecated}}
-The {{Tl|Deprecated template}} template notifies users that a given template has been replaced by a different one or ones, or simply [[Deprecation|deprecated]] (advised to no longer be used) without a replacement. This is useful when usage is different (so a redirect won't work) or you'd like to reduce the number of redirects (which makes bot parsing more difficult).
+The {{Tl|Deprecated template}} template notifies users that a given template has been replaced by a different one or ones, or simply [[Wikipedia:Deprecation|deprecated]] (advised to no longer be used) without a replacement. This is useful when usage is different (so a redirect won't work) or you'd like to reduce the number of redirects (which makes bot parsing more difficult).
 Whenever possible, it should replace the deprecated template's content entirely, so that someone using the template will see only the message.
@@ Line 22: / Line 22: @@
 If a deprecated template is still [[Wikipedia:Transclusion|in use]] on other pages, add {{Tag|noinclude}} tags around the {{Tl|Deprecated template}} template. That way the template page will show the deprecation tag, but pages using it will not. If a template has been fully deprecated, meaning that it not [[Wikipedia:Transclusion|in use]] on other pages, the noinclude tags may be removed. That way a deprecation tag will show on any page using the deprecated template. Afterwards consider nominating the template for [[Wikipedia:Templates for discussion|deletion]], or marking it with {{Tl|Historical template}}.
-=== Parameters ===
-;Standard
-{{Tlx|Deprecated template|Old|New|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
-{{Deprecated template|Old|New|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
-;Additional
-The template can show parameters as follows:
-{{Tlx|Deprecated template|Old|New|parameter}}
-{{Tlx|Deprecated template|Old|New|&lt;nowiki&gt;parameter{{=}}foo&lt;/nowiki&gt;}}
-{{Deprecated template|Old|New|parameter}}
-{{Deprecated template|Old|New|<nowiki>parameter=foo</nowiki>}}
-The template can also show a note:
-{{Tlx|Deprecated template|Old|New|note{{=}}Further details can be inserted here}}
-{{Deprecated template|Old|New|note=Further details can be inserted here, such as why the template is retained, or the particulars of the replacement process}}
-;Special parameters for templates outside template namespace.
-{{Para|old}} and {{Para|new}} can be used with the full names including namespace.
-{{Tlx|Deprecated template|old{{=}}Template:Old|new{{=}}Wikipedia:New}}
-{{Deprecated template|old=Template:Old|new=Wikipedia:New}}
-To link to a category full of templates, use <code>:Category:{{var|Name of category here}}</code>, with a leading colon.
-The {{para|new}} parameter cannot be used with the third unnamed parameter (the one illustrating a parameter of the third template). For example, this is not valid:<br />
-{{in5}}<code>{{!mxt|1=<nowiki>{{Deprecated template|Old|new=User:SnorkelWeasel/MyTemplate|&lt;nowiki&gt;chickens=yes&lt;/nowiki&gt;}}</nowiki>}}</code><br />
-Such a feature could be added, but it has never been needed yet.
-;Category suppression
-The template can be prevented from categorizing by adding <code><nowiki>|nocat=true</nowiki></code>. This is only intended for examples, e.g. in the template's own documentation.  In that case, not only the page itself will not be categorized, but transclusions of such pages will also be prevented from categorizing in [[:Category:Pages using deprecated templates]]. Do not use this parameter to passive-aggressively contest a template's documentation. Take up the matter on the template's talk page or that of a relevant other venue, such as [[WP:Village pump (technical)]].
-== See also ==
 For more detail see wikipedia page [[wikipedia:Template:Deprecated template]]