Difference between revisions of "Module:Check for deprecated parameters/doc"
Jump to navigation
Jump to search
blackwiki>Zackmann08 (→Usage) |
m (9 revisions imported) |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{Module rating | | + | {{Module rating |alpha<!-- Values: • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}} |
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | ||
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_]] | ||
| + | | 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> | ||
Latest revision as of 13:33, 26 September 2020
| This module is rated as alpha. It is ready for third-party input, and may be used on a few pages to see if problems arise, but should be watched. Suggestions for new features or changes in their input and output mechanisms are welcome. |
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_]]
| old_param1 = new_param1
| old_param2 = new_param2
| ....
| old_paramN = new_paramN
}}