Difference between revisions of "Template:DeprecatedTpl/Doc"

From Funtoo
Jump to: navigation, search
m
m
 
Line 1: Line 1:
 +
===Goal===
 +
 
This template provides a way to mark other templates (or even itself...) as deprecated. This gives visibility on deprecated templates that must be updated while reading a page. The list of deprecated templates can be seen [http://www.funtoo.org/index.php?title=Template:DeprecatedTpl&action=info#mw-pageinfo-templates here]. Then for each deprecated template you can check out <code>Tools > Page information</code> to list pages that include it.
 
This template provides a way to mark other templates (or even itself...) as deprecated. This gives visibility on deprecated templates that must be updated while reading a page. The list of deprecated templates can be seen [http://www.funtoo.org/index.php?title=Template:DeprecatedTpl&action=info#mw-pageinfo-templates here]. Then for each deprecated template you can check out <code>Tools > Page information</code> to list pages that include it.
 +
 +
===Usage===
  
 
DeprecatedTpl takes two optional arguments :
 
DeprecatedTpl takes two optional arguments :
Line 6: Line 10:
 
;use: Indicates the name of the template to use instead, if any.
 
;use: Indicates the name of the template to use instead, if any.
  
Examples:
+
===Examples===
  
 
{{file|name=Template:Fancynote|desc=The fancynote template deprecated|body=
 
{{file|name=Template:Fancynote|desc=The fancynote template deprecated|body=

Latest revision as of 07:05, September 29, 2014

Goal

This template provides a way to mark other templates (or even itself...) as deprecated. This gives visibility on deprecated templates that must be updated while reading a page. The list of deprecated templates can be seen here. Then for each deprecated template you can check out Tools > Page information to list pages that include it.

Usage

DeprecatedTpl takes two optional arguments :

inline
If set, the deprecation indicator will be designed inline, whatever the value. If not set, the deprecation indicator will be design as a block.
use
Indicates the name of the template to use instead, if any.

Examples

   Template:Fancynote - The fancynote template deprecated
{{note|{{{1}}}{{DeprecatedTpl}}}}
   Note

An example of the fancynote if it had the deprecated template

Wiki Editors: This template is deprecated.
   Template:Fancynote - The fancynote template deprecated with inline set
{{note|{{{1}}}{{DeprecatedTpl|inline=true}}}}
   Note

An example of the fancynote if it had the inline deprecated template deprecated

   Template:Fancynote - The fancynote template deprecated with use set
{{note|{{{1}}}{{DeprecatedTpl|use=Note}}}}
   Note

An example of the fancynote if it had the deprecated template

Wiki Editors: This template is deprecated, please use Template:Note instead.
   Template:Fancynote - The fancynote template deprecated with inline and use set
{{note|{{{1}}}{{DeprecatedTpl|inline=true|use=Note}}}}
   Note

An example of the fancynote if it had the inline deprecated template and information about replacement template. deprecated