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

From blackwiki
Jump to navigation Jump to search
imported>Debresser
(→‎Parameters: Rephrase to add clarity.)
imported>Debresser
(Remove to be deprecated parameters, change order.)
Line 37: Line 37:
 
{{Tlx|Deprecated template|Old|New|note{{=}}Further details can be inserted here}}
 
{{Tlx|Deprecated template|Old|New|note{{=}}Further details can be inserted here}}
 
{{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}}
 
{{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}}
 
 
The template can be stopped from categorizing non-template pages in [[:Category:Deprecated templates]] by adding <code><nowiki>|nocat=true</nowiki></code>, but transclusions of such pages will still categorize in [[:Category:Pages using deprecated templates]]. This is useful to track usage of deprecated pages that were used as "templates" while not actually being in template namespace.
 
  
  
Line 50: Line 47:
  
  
{{Para|4}} and {{Para|5}} can be used to indicate the namespaces of the  old and new template when they are not in template namespace. In that case {{Para|1}} and {{Para|2}} should be used with the name of the old and new template without namespace.
+
;Category surpression
  
{{Tlx|Deprecated template|1{{=}}Old|2{{=}}New|4{{=}}Template|5{{=}}Wikipedia}} gives the same result as in the example above using {{Para|old}} and {{Para|new}}:
+
The template can be stopped from categorizing non-template pages in [[:Category:Deprecated templates]] by adding <code><nowiki>|nocat=true</nowiki></code>, but transclusions of such pages will still categorize in [[:Category:Pages using deprecated templates]]. This is useful to track usage of deprecated pages that were used as "templates" while not actually being in template namespace.
{{Deprecated template|1=Old|2=New|4=Template|5=Wikipedia}}
 
  
 
== See also ==
 
== See also ==

Revision as of 06:49, 23 December 2013

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 only the message.

Usage

{{Deprecated template|old template name|new template name|date=January 2026}}

Usage without a date parameter categorizes templates to Category:Deprecated templates. Adding the date parameter categorizes the template to Category:Deprecated templates from January 2026.

This template changes style depending on what kind of page it is show on. Thus it adheres to the standardised looks for the different namespaces.

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, meaning that it 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, or marking it with {{Historical template}}.

Parameters

Standard

{{Deprecated template|Old|New|date=January 2026}}

Additional

The template can show parameters as follows:

{{Deprecated template|Old|New|parameter}}

{{Deprecated template|Old|New|<nowiki>parameter|fuu</nowiki>}}


The template can also show a note:

{{Deprecated template|Old|New|note=Further details can be inserted here}}


Special parameters for templates outside template namespace.

|old= and |new= can be used with the full names including namespace.

{{Deprecated template|old=Template:Old|new=Wikipedia:New}}


Category surpression

The template can be stopped from categorizing non-template pages in Category:Deprecated templates by adding |nocat=true, but transclusions of such pages will still categorize in Category:Pages using deprecated templates. This is useful to track usage of deprecated pages that were used as "templates" while not actually being in template namespace.

See also

  • {{Deprecated template-inline}} – same as this template, but for deprecated inline templates that are being kept around (in name, at least) for historical reasons
  • {{Db-deprecated}} – for deprecated templates that have been slated for deletion
  • {{Deprecated stub}} – for deprecated stub templates
  • {{Deprecated shortcut}} – for deprecated shortcuts
  • {{Obsolete template}}
  • {{Historical template}} - for deprecated templates that are kept for historical reasons
  • Category:Deprecated templates – the category where this template lists templates it is used on
  • {{Xtd}} (and related templates) – for indicating deprecated (and good, bad and neutral) examples in guidelines, how-tos and template documentation
  • {{Dc}} – inline deprecated code or text; {{Dc2}} variant has strikethrough (both explicitly use the <del> element, and can be used in articles, e.g. about HTML or other specifications that may have deprecated features)