Template:Deprecated template/doc

From 'City of Adelaide' History and Genealogy Site
Jump to navigation Jump to search

{{#invoke:Message box|mbox}}

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=December 2024}}

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

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 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.

Parameters

Standard

{{Deprecated template|Old|New|date=December 2024}} {{#invoke:Message box|ombox}}

Additional

The template can show parameters as follows:

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

{{Deprecated template|Old|New|<nowiki>parameter|fuu</nowiki>}} {{#invoke:Message box|ombox}} {{#invoke:Message box|ombox}}


The template can also show a note:

{{Deprecated template|Old|New|note=Further details can be inserted here}} {{#invoke:Message box|ombox}}


The template can be stopped from categorizing by adding |nocat=true.


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}} {{#invoke:Message box|ombox}}


|4= and |5= can be used to indicate the namespaces of the old and new template when they are not in template namespace. In that case |1= and |2= should be used with the name of the old and new template without namespace.

{{Deprecated template|1=Old|2=New|4=Template|5=Wikipedia}} gives the same result as in the example above using |old= and |new=: {{#invoke:Message box|ombox}}

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
  • {{Sdeprecated}} – for deprecated shortcuts
  • {{Obsolete template}}
  • 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)