Template:deprecated/documentation
Appearance
When put into another template, {{deprecated}}
generates a box warning and places them into [[Category:Deprecated templates]]
.
Usage
[edit]To generate the box, simply include it at the top of a template or module's documentation page:
{{documentation subpage}} {{deprecated}} ...rest of documentation...
A link to a replacement can be included by adding its template name as a parameter. A maximum of two alternatives may be linked to in this way.
Examples
[edit]- To simply mark
{{foo}}
as deprecated, use the following code in it.{{deprecated}}
- To replace
{{foo}}
with{{bar}}
, use the following code in Template:foo to include a link to Template:bar.{{deprecated|Template:bar}}
- To replace
{{foobar}}
with{{foo}}
and{{bar}}
, use the following code in Template:foobar to link to both Template:foo and Template:bar.{{deprecated|Template:foo|Template:bar}}