Difference between revisions of "Template:Deprecated template/doc"
imported>Rich Farmbrough m (Rich Farmbrough moved page Template:Tdeprecated/doc to Template:Deprecated template/doc: Full words,word order) |
imported>Rich Farmbrough |
||
| Line 2: | Line 2: | ||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. --> | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. --> | ||
| − | The {{tl| | + | The {{tl|Deprecated template}} template notifies users that a given template has been replaced by a different one. This is useful when usage is different (so a redirect won't work) or you'd like to reduce the number of redirects (which makes bot parsing more difficult). |
Whenever possible, it should replace the deprecated template's content entirely, so that someone using the template will see the message. | Whenever possible, it should replace the deprecated template's content entirely, so that someone using the template will see the message. | ||
| Line 8: | Line 8: | ||
=== Usage === | === Usage === | ||
| − | {{tlx| | + | {{tlx|Deprecated template|old template name|new template name|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} |
Usage without a date parameter categorises templates to [[:Category:Deprecated templates]]. Adding the date parameter categorises the template to [[:Category:Deprecated templates from {{CURRENTMONTHNAME}} {{CURRENTYEAR}}]]. | Usage without a date parameter categorises templates to [[:Category:Deprecated templates]]. Adding the date parameter categorises the template to [[:Category:Deprecated templates from {{CURRENTMONTHNAME}} {{CURRENTYEAR}}]]. | ||
| − | If a deprecated template is still [[Wikipedia:Transclusion|in use]] on other pages, add {{tag|noinclude}} tags around the {{tl| | + | If a deprecated template is still [[Wikipedia:Transclusion|in use]] on other pages, add {{tag|noinclude}} tags around the {{tl|Deprecated template}} template. That way the template page will show the deprecation tag, but pages using it will not. If a template has been fully deprecated and is not [[Wikipedia:Transclusion|in use]] on other pages, the noinclude tags may be removed. That way a deprecation tag will show on any page using the deprecated template. Afterwards consider nominating the template for [[Wikipedia:Templates for discussion|deletion]]. |
=== Examples === | === Examples === | ||
<pre> | <pre> | ||
| − | {{ | + | {{Deprecated template|old|new}} |
| − | {{ | + | {{Deprecated template|old|new|parameter}} |
| − | {{ | + | {{Deprecated template|old|new|<nowiki>parameter|fuu</nowiki>}} |
</pre> | </pre> | ||
| − | {{ | + | {{Deprecated template|old|new|category=}} |
| − | {{ | + | {{Deprecated template|old|new|parameter|category=}} |
| − | {{ | + | {{Deprecated template|old|new|<nowiki>parameter|fuu</nowiki>|category=}} |
=== Technical details === | === Technical details === | ||
| Line 29: | Line 29: | ||
This template changes style depending on what kind of page it is show on. Thus it adheres to the standardised looks for the different pages. For instance if this template becomes visible in an article it looks like this: | This template changes style depending on what kind of page it is show on. Thus it adheres to the standardised looks for the different pages. For instance if this template becomes visible in an article it looks like this: | ||
| − | {{ | + | {{Deprecated template|demospace=main|old|new}} |
=== See also === | === See also === | ||
| − | * {{tl| | + | * {{tl|Deprecated template-inline}} – for deprecated inline templates |
* {{tl|Deprecated stub}} – for deprecated stub templates | * {{tl|Deprecated stub}} – for deprecated stub templates | ||
* {{tl|Sdeprecated}} – for deprecated shortcuts | * {{tl|Sdeprecated}} – for deprecated shortcuts | ||
Revision as of 01:16, 8 March 2012
| 40px | This is a documentation subpage for Template:Deprecated template. It contains usage information, categories and other content that is not part of the original template page. |
The {{Deprecated template}} template notifies users that a given template has been replaced by a different one. This is useful when usage is different (so a redirect won't work) or you'd like to reduce the number of redirects (which makes bot parsing more difficult).
Whenever possible, it should replace the deprecated template's content entirely, so that someone using the template will see the message.
Usage
{{Deprecated template|old template name|new template name|date=January 2026}}
Usage without a date parameter categorises templates to Category:Deprecated templates. Adding the date parameter categorises the template to Category:Deprecated templates from January 2026.
If a deprecated template is still in use on other pages, add <noinclude>...</noinclude> tags around the {{Deprecated template}} template. That way the template page will show the deprecation tag, but pages using it will not. If a template has been fully deprecated and is not in use on other pages, the noinclude tags may be removed. That way a deprecation tag will show on any page using the deprecated template. Afterwards consider nominating the template for deletion.
Examples
{{Deprecated template|old|new}}
{{Deprecated template|old|new|parameter}}
{{Deprecated template|old|new|<nowiki>parameter|fuu</nowiki>}}
| Template:old is deprecated. Please use Template:new instead. |
Template:old is deprecated. Please use {{new|parameter}} instead. |
Template:old is deprecated. Please use {{new|parameter|fuu}} instead. |
Technical details
This template changes style depending on what kind of page it is show on. Thus it adheres to the standardised looks for the different pages. For instance if this template becomes visible in an article it looks like this:
| Template:old is deprecated. Please use Template:new instead. |
See also
- {{Deprecated template-inline}} – for deprecated inline templates
- {{Deprecated stub}} – for deprecated stub templates
- {{Sdeprecated}} – for deprecated shortcuts
- Category:Deprecated templates – the category where this template lists templates it is used on
Redirects