Template:Deprecated template/doc: Difference between revisions
Jump to navigation
Jump to search
ArrowHead294 (talk | contribs) mNo edit summary |
clarify how this template should be used |
||
| Line 1: | Line 1: | ||
{{dochead}}{{substitute|no}} | {{dochead}}{{substitute|no}}{{wikipedia|Template:Deprecated template}} | ||
: ''Not to be confused with [[Template:Deprecated]].'' | : ''Not to be confused with [[Template:Deprecated]].'' | ||
'''{{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]]. | |||
=== Usage === | === Usage === | ||
| Line 24: | Line 22: | ||
=== 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]] | ||
Revision as of 10:21, 24 October 2025
| This template should not be substituted. |
- 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|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
- 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 parameters – for template parameters whose use is no longer advised.
- Category:Deprecated templates
- Category:Pages with deprecated templates
