Template:Deprecated template/doc
Script error: No such module "Message box". Script error: No such module "Shortcut".
The Template:Tl is a template placed in a given template's code to notify its users that a given template has been superseded or replaced by another template, or has simply been deprecated (i.e., advised to no longer be used) without a direct replacement. It is useful when a redirect is ineffective due to usage differences, or when reducing the number of redirects is desired to simplify bot parsing.
If the template is fully deprecated, the deprecated template's content can be fully replaced/overridden by the message from Template:Tlc using <includeonly>...</includeonly>, ensuring that anyone using the template will only see the notification, and not invoke the deprecated template.
Template:Tl is a related template for use on templates where there is consensus for that template to be deprecated, but where removal of the template would seriously break the functionality of historical project pages.
Template:Tl provides a way to delete templates but still retain them for the purpose of correctly displaying old revisions of pages.
Usage
Templates not fully deprecated
If the deprecated template is not yet ready for full deprecation since it is still in use (transcluded) on pages, add <noinclude>...</noinclude> tags around the Template:Tlc template in the source code of the deprecated template. This ensures that the deprecation notice appears only on the template’s documentation page and not on every page where the template is transcluded.
If the template is not yet fully deprecated insert in the template's code:
<noinclude>
{{Deprecated template}} <!-- Replace with {{Deprecated template|old template name|new template name}} and remove <noinclude> tags when fully deprecated. See [[Template:Deprecated template]] for more information. -->
</noinclude>
Fully deprecated templates
Once a template has been fully deprecated and is no longer transcluded on any pages, you can remove the <noinclude>...</noinclude> tags surrounding the Template:Tlc in the deprecated template's source code. This will display the deprecation notice on any pages still using the deprecated template.
Afterward, consider nominating the template for deletion through Wikipedia:Templates for discussion, or replacing it with Template:Tl to indicate its deprecated status.
{{Deprecated template|Deprecated template name|New template name}}
Usage without a second (replacement) template name simply produces:
Script error: No such module "Unsubst".
Parameters
Standard
Template:Tlx Script error: No such module "Unsubst".
Additional
The template can show parameters as follows:
Template:Tlx Script error: No such module "Unsubst". Script error: No such module "Unsubst".
The template can also show a note:
Template:Tlx Script error: No such module "Unsubst".
The |note= parameter can also be given as |reason= or |result=.
Special parameters for templates outside template namespace.
|old= and |new= can be used with the full names including namespace.
Template:Tlx Script error: No such module "Unsubst".
To link to a category full of templates, use :Category:Name of category here, 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:
Template:In5Template:!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
- Template:Tl - for deprecated templates that are kept for historical reasons
- Category:Deprecated templates – the category where this template lists templates it is used on
- Template:Tl (and related templates) – for indicating deprecated (and good, bad and neutral) examples in guidelines, how-tos and template documentation
- Template:Tl – inline Template:Dc; Template:Tl variant has Template:Dc2 (both explicitly use the
<del>element, and can be used in articles, e.g. about HTML or other specifications that may have deprecated features) - Template:Tl – for Wikipedia pages
- Template:Tl – for media files
- Template:Tl – for deleting a template without breaking old revisions
TemplateData
Notifies users that a given template has been superseded or replaced by another template, or has simply been deprecated (i.e., advised to no longer be used) without a direct replacement.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Deprecated template name | old 1 | Name of the template to be replaced
| Line | suggested |
| Replacement | new 2 | The page name of a template which supersedes the deprecated template. It is unnecessary to use namespace prefix, but it may be used, even for other namespaces. To link to a category full of templates, use :Category:Name of category here, with a leading colon. | Line | suggested |
| Parameter | 3 | The template can show parameters for the new template, must use <nowiki></nowiki> tags
| Content | suggested |
| Note | note reason result | Explanation of why the template is deprecated, documentation on how it should be replaced, or any other helpful information. | Content | suggested |
| Deprecated by | by | Who/what deprecated the template? | Line | suggested |
| Kept for historical reasons? | historical | Any value will output: "and is preserved only for historical reasons"
| Boolean | optional |
| Suppress categorisation | nocat | 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).
| Boolean | optional |