Teamplaid:Deprecated template/documentation

O Wiktionary
Jump to navigation Jump to search

Teamplaid:tsh

The {{Deprecated template}} 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. 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[deasaich]

{{deprecated template|old template name|new template name|date=dhen Mhàrt 2020}}

Usage without a date parameter categorizes templates to Category:Deprecated templates. Adding the date parameter categorizes the template to Category:Deprecated templates from dhen Mhàrt 2020.

Usage without a second (replacement) template name simply produces:

Script error: No such module "Unsubst".

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

If a deprecated template is still in use on other pages, add Teamplaid:Tag 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[deasaich]

Standard

{{deprecated template|Old|New|date=dhen Mhàrt 2020}} Script error: No such module "Unsubst".

Additional

The template can show parameters as follows:

{{deprecated template|Old|New|parameter}}

{{deprecated template|Old|New|<nowiki>parameter=foo</nowiki>}} Script error: No such module "Unsubst". Script error: No such module "Unsubst".


The template can also show a note:

{{deprecated template|Old|New|note=Further details can be inserted here}} Script error: No such module "Unsubst".


Special parameters for templates outside template namespace.

Teamplaid:Para and Teamplaid:Para can be used with the full names including namespace.

{{deprecated template|old=Template:Old|new=Wikipedia:New}} Script error: No such module "Unsubst".

To link to a category full of templates, use :Category:Teamplaid:var, with a leading colon.

The |new=

parameter cannot be used with the third unnamed parameter (the one illustrating a parameter of the third template). For example, this is not valid:

Teamplaid:in5Teamplaid:!mxt
Such a feature could be added, but it has never been needed yet.

Category suppression

The template can be prevented from categorizing by adding |nocat=true. This is only intended for examples, e.g. in the template's own documentation. In that case, not only the page itself will not be categorized, but transclusions of such pages will also be prevented from categorizing in Category:Pages using deprecated templates. Do not use this parameter to passive-aggressively contest a template's documentation. Take up the matter on the template's talk page or that of a relevant other venue, such as WP:Village pump (technical).

See also[deasaich]