Template:Deprecated template/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
ArrowHead294 (talk | contribs)
No edit summary
ArrowHead294 (talk | contribs)
mNo edit summary
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{dochead}}
{{dochead}}{{substitute|no}}
: ''Not to be confused with [[Template:Deprecated]].''
 
The <code>{{<nowiki />'''Deprecated template'''}}</code> 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.
 
Whenever possible, this template should replace the deprecated template's content entirely, so that someone using the template will see only the message.
Whenever possible, this template should replace the deprecated template's content entirely, so that someone using the template will see only the message.


== Usage ==
=== Usage ===
Use as follows:
Use as follows:


: <code><nowiki>{{Deprecated template|Old template|Template: New template|details=Further details.}}</nowiki></code>
<pre>{{Deprecated template|Old template|Template: New template|details=Further details.}}</pre>


to get:
to get:


{{Mbox
{{Mbox
| icon = Icon-Deprecated.png
| type = delete
| type = delete
| text = '''Template: Old template''' is deprecated. Please use [[Template: New template]] instead. Further details.
| text = '''Template: Old template''' is deprecated. Please use [[Template: New template]] instead. Further details.
Line 19: Line 24:


=== See also ===
=== See also ===
* [[Template:Deprecated]]
* [[Template:Deprecated]] – for pages whose material is no longer valid.
* [[Template:Deprecated parameters]] – for template parameters whose use is no longer advised.
* [[:Category:Deprecated templates]]
* [[:Category:Deprecated templates]]
* [[:Category:Pages with deprecated templates]]
* [[:Category:Pages with deprecated templates]]

Latest revision as of 21:43, 25 May 2025

This template should not be substituted.
Not to be confused with Template:Deprecated.

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.

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

Usage

Use as follows:

{{Deprecated template|Old template|Template: New template|details=Further details.}}

to get:

Template: Old template is deprecated. Please use Template: New template instead. Further details.

The last two parameters are optional. This can be useful when the template was replaced by something other than a new template, like a category.

The parameter names can be omitted if they are used in the same order as specified above.

See also