Difference between revisions of "Template:Deprecated template/doc"

From blackwiki
Jump to navigation Jump to search
imported>Ahora
imported>Ahora
m (Shortcuts.)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
 +
{{tsh|Tdeprecated|TemplateObsolete}}
  
 
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).
 
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).
Line 40: Line 41:
 
* [[:Category:Deprecated templates]]&nbsp;– the category where this template lists templates it is used on
 
* [[:Category:Deprecated templates]]&nbsp;– the category where this template lists templates it is used on
 
* {{tl|xtd}} and {{tl|bxtd}}&nbsp;– for indicating deprecated usages in general and source code, respectively
 
* {{tl|xtd}} and {{tl|bxtd}}&nbsp;– for indicating deprecated usages in general and source code, respectively
 
=== Redirects ===
 
* {{tl|Deprecated template}}
 
  
 
<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->

Revision as of 07:45, 20 October 2012

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>}}
{{Deprecated template|old|new|note=Further details can be inserted here, such as why the template is retained, or the particulars of the replacement process}}

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:

See also