PorkchopGMX (talk | contribs) Reverted 1 edit by JsfasdF252 (talk): Attribution is required in CC-BY-SA images |
Trialpears (talk | contribs) m Trialpears moved page Template:Deprecated to Template:Deprecated template over redirect: Revert undiscussed move, see talk |
| (One intermediate revision by one other user not shown) | |
(No difference)
| |
Revision as of 23:36, 1 May 2021
Template documentation[view] [edit] [history] [purge]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}}
Usage without a second (replacement) template name simply produces:
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}}.
Parameters
- Standard
{{Deprecated template|Old|New}}
- Additional
The template can show parameters as follows:
{{Deprecated template|Old|New|parameter}}
{{Deprecated template|Old|New|<nowiki>parameter=foo</nowiki>}}
The template can also show a note:
{{Deprecated template|Old|New|note=Further details can be inserted here}}
The |note= parameter can also be given as |reason= or |result=.
- Special parameters for templates outside template namespace.
|old= and |new= can be used with the full names including namespace.
{{Deprecated template|old=Template:Old|new=Wikipedia:New}}
To link to a category full of templates, use :Category:Name of category here, with a leading colon.
The |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:
{{Deprecated template|Old|new=User:SnorkelWeasel/MyTemplate|<nowiki>chickens=yes</nowiki>}}
Such a feature could be added, but it has never been needed yet.
- Category suppression
The template can be prevented from categorizing by adding |nocat=true. 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
- {{Deprecated stub}} – for deprecated stub templates
- {{Historical template}} - for deprecated templates that are kept for historical reasons
- Category:Deprecated templates – the category where this template lists templates it is used on
- {{Xtd}} (and related templates) – for indicating deprecated (and good, bad and neutral) examples in guidelines, how-tos and template documentation
- {{Dc}} – inline
deprecated code or text; {{Dc2}} variant hasstrikethrough(both explicitly use the<del>element, and can be used in articles, e.g. about HTML or other specifications that may have deprecated features) - {{Superseded}} – for Wikipedia pages
- {{Obsolete}} – for media files
- {{Deleted template}} – for deleting a template without breaking old revisions