Template:Deprecated template/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
ArrowHead294 (talk | contribs)
m Use "pre" instead
Overthink (talk | contribs)
update
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{dochead}}
{{dochead}}{{substitute|no}}{{wikipedia|Template:Deprecated template}}
: ''Not to be confused with [[Template:Deprecated]].''
: ''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.
'''{{ARTICLEROOTPAGENAME}}''' notifies users that a template has been replaced by one or more new templates, or deprecated (advised to no longer be used) without a replacement. This template should ''not'' be placed in a page's documentation page; instead, it is placed ''within'' a template's code, either as part of it or replacing it entirely, to notify editors about that template's status. Pages that include this template are placed under [[:Category:Pages with deprecated templates]].
 
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:


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


to get:
to get:


{{Mbox
{{Deprecated template|Template: Old template|Template: New template|details=Further details.}}
| icon = Icon-Deprecated.png
 
| type = delete
Note: The <code><nowiki><includeonly></nowiki></code> and <code><nowiki></includeonly></nowiki></code> tags are needed for the template to work properly on both the template page and pages where the deprecated template is transcluded.
| text = '''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 last two parameters are optional. This can be useful when the template was replaced by something other than a new template, like a category.
Line 24: Line 20:


=== See also ===
=== See also ===
* [[Template:Template rating]] – a similar template to be used for a template's documentation.
* [[Template:Deprecated]] – for pages whose material is no longer valid.
* [[Template:Deprecated]] – for pages whose material is no longer valid.
* [[Template:Deprecated parameters]] – for template parameters whose use is no longer advised.
* [[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 04:19, 2 May 2026

This template should not be substituted.
English Wikipedia has an article on:
Not to be confused with Template:Deprecated.

Template:Deprecated template notifies users that a template has been replaced by one or more new templates, or deprecated (advised to no longer be used) without a replacement. This template should not be placed in a page's documentation page; instead, it is placed within a template's code, either as part of it or replacing it entirely, to notify editors about that template's status. Pages that include this template are placed under Category:Pages with deprecated templates.

Usage

Use as follows:

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

to get:

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

Details: Further details.


Note: The <includeonly> and </includeonly> tags are needed for the template to work properly on both the template page and pages where the deprecated template is transcluded.

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