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}} is a template placed ''in'' a given template's code to notify its users that a given template has been superseded or replaced by another template, or has simply been [[Deprecation|deprecated]] (i.e., advised to no longer be used) without a direct replacement. It is useful when a [[Wikipedia:Redirect|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 can be fully replaced/overridden by the message from {{Tlc|Deprecated template}} using {{tag|includeonly}}, ensuring that anyone using the template will only see the notification, and not invoke the deprecated template.

{{tl|Historical template}} is a related template for use on templates where there is consensus for that template to be deprecated, but where removal of the template would seriously break the functionality of historical project pages.

{{tl|Deleted template}} provides a way to delete templates but still retain them for the purpose of correctly displaying'' old revisions'' of pages.

=== Usage ===

==== Templates not fully deprecated ====

If the deprecated template is ''not yet ready'' for full deprecation since it is still [[Wikipedia:Transclusion|in use]] (transcluded) on pages, add {{Tag|noinclude}} tags around the {{Tlc|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.

If the template is ''not yet fully'' deprecated insert in the template's code:

<syntaxhighlight lang="wikitext">
<noinclude>
{{Deprecated template}} <!-- Replace with {{Deprecated template|old template name|new template name}} and remove <noinclude> tags when fully deprecated. See [[Template:Deprecated template]] for more information. -->
</noinclude>
</syntaxhighlight>

==== Fully deprecated templates ====

Once a template has been ''fully deprecated'' and is no longer transcluded on any pages, you can remove the {{Tag|noinclude}} tags surrounding the {{Tlc|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 replacing it with {{tl|Historical template}} to indicate its deprecated status.

<syntaxhighlight lang="wikitext">
{{Deprecated template|Deprecated template name|New template name}}
</syntaxhighlight>

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

{{Deprecated template|nocat=y}}

=== Parameters ===

'''Standard'''

{{Tlx|Deprecated template|Old|New}}
{{Deprecated template|Old|New}}

'''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, such as why the template is retained, the particulars of the replacement process, or when there are two or more replacements.}}
{{Deprecated template|Old|New|note=Further details can be inserted here, such as why the template is retained, the particulars of the replacement process, or when there are two or more replacements.}}

The {{para|note}} parameter can also be given as {{para|reason}} or {{para|result}}.


'''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|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
* {{tl|Deleted template}} – for deleting a template without breaking old revisions

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

==TemplateData==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"3": {
			"label": "Parameter",
			"description": "The template can show parameters for the new template, must use <nowiki></nowiki> tags",
			"example": "<nowiki>parameter=foo</nowiki>",
			"type": "content",
			"suggested": true
		},
		"old": {
			"aliases": [
				"1"
			],
			"label": "Deprecated template name",
			"description": "Name of the template to be replaced",
			"type": "line",
			"default": "{{PAGENAME}}",
			"suggested": true
		},
		"by": {
			"label": "Deprecated by",
			"description": "Who/what deprecated the template?",
			"type": "line",
			"suggested": true
		},
		"historical": {
			"label": "Kept for historical reasons?",
			"description": "Any value will output: \"and is preserved only for historical reasons\"",
			"example": "yes",
			"type": "boolean"
		},
		"new": {
			"aliases": [
				"2"
			],
			"label": "Replacement",
			"description": "The page name of a template which supersedes the deprecated template. 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.",
			"type": "line",
			"suggested": true
		},
		"note": {
			"aliases": [
				"reason",
				"result"
			],
			"label": "Note",
			"description": "Explanation of why the template is deprecated, documentation on how it should be replaced, or any other helpful information.",
			"type": "content",
			"suggested": true
		},
		"nocat": {
			"label": "Suppress categorisation",
			"description": "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",
			"type": "boolean"
		}
	},
	"description": "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.",
	"paramOrder": [
		"old",
		"new",
		"3",
		"note",
		"by",
		"historical",
		"nocat"
	],
	"format": "inline"
}
</templatedata>