Difference between revisions of "Module:Check for deprecated parameters/doc"
Jump to navigation
Jump to search
blackwiki>Zackmann08 (→Usage) |
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. | ||
| − | + | '''Note:''' due to the nature of deprecations, this module will often have no templates implementing it. | |
| − | |||
== 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> | ||
| − | + | ==See also== | |
| − | + | * [[Module:Check for unknown parameters]] | |
| − | <includeonly>{{ | + | <includeonly>{{sandbox other|| |
| − | <!-- Categories | + | <!-- Categories go here and interwikis go in Wikidata. --> |
}}</includeonly> | }}</includeonly> | ||
Revision as of 20:12, 30 November 2018
| This module is rated as pre-alpha. It is unfinished, and may or may not be in active development. It should not be used from article namespace pages. Modules remain pre-alpha until the original editor (or someone who takes one over if it is abandoned for some time) is satisfied with the basic structure. |
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
}}