Template:Deprecated template/doc

The {{Deprecated template}} template notifies users that a given template has been superseded or replaced by another template, or has simply been deprecated (i.e., advised to no longer be used) without a direct replacement. It is useful when a redirect is ineffective due to usage differences, or when reducing the number of redirects is desired to simplify bot parsing.

If the template is fully deprecated, the deprecated template’s content should be fully replaced/overridden by the message from {{Deprecated template}}, ensuring that anyone using the template will only see the notification, and not invoke the deprecated template.

Usage

Templates not fully deprecated

If the deprecated template is not yet ready for full deprecation since it is still in use (transcluded) on pages, add <noinclude>...</noinclude> tags around the {{Deprecated template}} template in the source code of the deprecated template. This ensures that the deprecation notice appears only on the template’s documentation page and not on every page where the template is transcluded.

Fully deprecated templates

Once a template has been fully deprecated and is no longer transcluded on any pages, you can remove the <noinclude>...</noinclude> tags surrounding the {{Deprecated template}} in the deprecated template’s source code. This will display the deprecation notice on any pages still using the deprecated template.

Afterward, consider nominating the template for deletion through Wikipedia:Templates for discussion or marking it with {{Historical template}} to indicate its deprecated status.

Note that deprecated stub templates are not normally deleted, as they are used as soft redirects. These should be marked with {{Deprecated stub}}.

{{Deprecated template|old template name|new template name}}

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

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 has strikethrough (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

Notifies users that a given template has been superseded or replaced by another template, or has simply been deprecated (i.e., advised to no longer be used) without a direct replacement.

Template parameters

Parameter		Description	Type	Status
1	1	no description	Unknown	optional
2	2	no description	Unknown	optional
Parameter	3	The template can show parameters for the new template, must use <nowiki></nowiki> tags Example <nowiki>parameter=foo</nowiki>	Content	optional
Deprecated template name	old 1	Defaults to template name	Unknown	optional
Deprecated by	by	Who/what deprecated the template?	Unknown	optional
Kept for historical reasons?	historical	Any value will output: "and is preserved only for historical reasons" Example yes	Unknown	optional
Superseding/replacement template name	new 2	It is unnecessary to use namespace prefix, but it may be used, even for other namespaces. To link to a category full of templates, use :Category:Name of category here, with a leading colon.	String	suggested
Note	note reason result	no description	Unknown	optional
reason	reason	no description	Unknown	optional
result	result	no description	Unknown	optional
Suppress categorisation	nocat	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). Example true	Boolean	optional