Jump to content

မေႃႇၵျူး:Check for deprecated parameters/doc

လုၵ်ႉတီႈ ဝီႇၶီႇၽီးတီးယႃး ဢၼ်လွတ်ႈလႅဝ်းထၢင်ႇႁၢင်ႈ ၼၼ်ႉမႃး

This is the documentation page for မေႃႇၵျူး:Check for deprecated parameters

Module:Check for deprecated parameters may be appended to a template to check for uses of deprecated parameters. It will place the page in a specific category, and display a preview message, when it finds deprecated parameter uses.

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

{{#invoke:Check for deprecated parameters|check
| category = {{main other|[[Category:Pages using TEMPLATENAME with deprecated parameters|_VALUE_]]}}
| _remove = RemoveParam1; RemoveParam2
| old_param1 = new_param1 
| old_param2 = new_param2
| ....
| old_paramN = new_paramN
}}
  • |category= - what happens when an unknown parameter is used. Typically use either a tracking category to place pages that use deprecated parameters, or an error.
  • |_remove= - a ; separated list of parameters that should simply be removed from the template, not replaced with another. For example: |_remove=Param1; Param2; Param3
  • |ignoreblank= – by default, the module makes no distinction between a defined-but-blank parameter and a non-blank parameter. That is, both unlisted |foo=x and |foo= are reported. To only track non-blank parameters use |ignoreblank=1. If you clean your arguments with Module:Arguments and call this module afterwards, you need not use this parameter as that module ignores blank arguments by default.
  • |preview= – set a custom preview warning message. Note the default is Page using LINKED_TEMPLATE_NAME with deprecated parameter _VALUE_