Template:Deprecated template/doc: Difference between revisions

ArrowHead294 (talk | contribs)
mNo edit summary
Ganaram inukshuk (talk | contribs)
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]].''


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 ===
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]]