Difference between revisions of "Module:Check for deprecated parameters/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Zackmann08
blackwiki>Zackmann08
(WIP)
Line 3: Line 3:
 
This module may be appended to a template to check for uses of deprecated parameters. The purpose is to locate deprecated parameters, display a message and place the page in a specific category noting that it is deprecated.
 
This module may be appended to a template to check for uses of deprecated parameters. The purpose is to locate deprecated parameters, display a message and place the page in a specific category noting that it is deprecated.
  
==TO DO==
+
'''Note:''' due to the nature of deprecations, this module will often have no templates implementing it.
* limit to certain namespaces
 
  
 
== Usage ==
 
== Usage ==
 +
<pre>
 +
{{#invoke:check for deprecated parameters|check
 +
|category=[[Category:<category_name>|_VALUE_]]
 +
|preview =Page using [[TEMPLATE_NAME]] with deprecated parameter _VALUE_
 +
| old_param1 = new_param1
 +
| old_param2 = new_param2
 +
| ....
 +
| old_paramN = new_paramN
 +
}}
 +
</pre>
  
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|''check''}}</code>
+
==See also==
 
+
* [[Module:Check for unknown parameters]]
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
+
<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
+
<!-- Categories go here and interwikis go in Wikidata. -->
  
 
}}</includeonly>
 
}}</includeonly>

Revision as of 20:12, 30 November 2018

This module may be appended to a template to check for uses of deprecated parameters. The purpose is to locate deprecated parameters, display a message and place the page in a specific category noting that it is deprecated.

Note: due to the nature of deprecations, this module will often have no templates implementing it.

Usage

{{#invoke:check for deprecated parameters|check
|category=[[Category:<category_name>|_VALUE_]]
|preview =Page using [[TEMPLATE_NAME]] with deprecated parameter _VALUE_
| old_param1 = new_param1 
| old_param2 = new_param2
| ....
| old_paramN = new_paramN
}}

See also