View source for Template:Deprecated template/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{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).

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

=== Usage ===

{{Tlx|Deprecated template|old template name|new template name|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}

Usage without a date parameter categorizes templates to [[:Category:Deprecated templates]]. Adding the date parameter categorizes the template to [[:Category:Deprecated templates from {{CURRENTMONTHNAME}} {{CURRENTYEAR}}]].

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

{{Deprecated template|nocat=y}}

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 [[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 ==

* {{Tl|Deprecated template-inline}}&nbsp;– same as this template, but for deprecated [[WP:WPILT|inline templates]] that are being kept around (in name, at least) for historical reasons
* {{Tl|Deprecated stub}}&nbsp;– for deprecated stub templates
* {{Tl|Historical template}} - for deprecated templates that are kept for historical reasons
* [[:Category:Deprecated templates]]&nbsp;– the category where this template lists templates it is used on
* {{Tl|Xtd}} (and [[Template:Xt/see also|related templates]])&nbsp;– for indicating deprecated (and good, bad and neutral) examples in guidelines, how-tos and template documentation
* {{Tl|Dc}}&nbsp;– inline {{Dc|deprecated code or text}}; {{Tl|Dc2}} variant has {{Dc2|strikethrough}} (both explicitly use the {{Tag|del|open}} element, and can be used in articles, e.g. about HTML or other specifications that may have deprecated features)
* {{tl|Superseded}} – for Wikipedia pages
* {{tl|Obsolete}} – for media files

<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Template namespace templates]]
[[Category:Deprecated templates| ]]
}}</includeonly>