Module:Check for deprecated parameters
Appearance
From Wikipedia, the free encyclopedia
This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing.
Page template-protected This module is currently protected from editing.
See the protection policy and protection log for more details. Please discuss any changes on the talk page; you may submit an edit request to ask an administrator to make an edit if it is uncontroversial or supported by consensus. You may also request that this page be unprotected.
See the protection policy and protection log for more details. Please discuss any changes on the talk page; you may submit an edit request to ask an administrator to make an edit if it is uncontroversial or supported by consensus. You may also request that this page be unprotected.
Warning This Lua module is used on approximately 254,000 pages .
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.
This module depends on the following other modules:
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.
Usage
{{#invoke:Check for deprecated parameters|check | category = [[Category:category_name|_VALUE_]] | old_param1 = new_param1 | old_param2 = new_param2 | .... | old_paramN = new_paramN }}
By default, this module will flag empty uses of deprecated parameters. To turn this off, set |ignoreblank=yes
.
See also
- Category:Deprecated parameters
- Module:Params – for complex operations involving parameters
- Module:Check for unknown parameters
- Module:Check for clobbered parameters – module that checks for conflicting parameters
The above documentation is transcluded from Module:Check for deprecated parameters/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (create) pages.
Subpages of this module.
Editors can experiment in this module's sandbox (edit | diff) and testcases (create) pages.
Subpages of this module.
-- This module may be used to compare the arguments passed to the parent -- with a list of arguments, returning a specified result if an argument is -- on the list localp={} localfunctiontrim(s) returns:match('^%s*(.-)%s*$') end localfunctionisnotempty(s) returnsandtrim(s)~='' end functionp.check(frame) -- create the table of deprecated values and their matching new value localargs=frame.args localdep_values={} fork,vinpairs(args)do ifk=='ignoreblank'ork=='preview'ork=='deprecated'thenelse dep_values[k]=v end end -- loop over the parent args and see if any are deprecated localvalues={} localignoreblank=isnotempty(frame.args['ignoreblank']) localpargs=frame:getParent().args fork,vinpairs(pargs)do ifignoreblankthen ifdep_values[k]andv~=''then table.insert(values,k) end else ifdep_values[k]then table.insert(values,k) end end end -- add results to the output tables localres={} if#values>0then localpreview=frame.args['preview']or 'Page using [['..frame:getParent():getTitle()..']] with deprecated parameter _VALUE_' ifisnotempty(preview)then preview=require('Module:If preview')._warning({ preview }) end -- Kind of dangerous to trust that this is never nil, but I guess it's -- preferable to display that the use of the module is broken rather than -- have some sort of tracking category for pages which have an unknown -- parent tracking template. localcategory=frame.args['category'] fork,vinpairs(values)do localc=category:gsub('_VALUE_',v) table.insert(res,c) ifv==''then -- Fix odd bug for | = which gets stripped to the empty string -- and breaks category links v=' ' end localp=preview:gsub( '_VALUE_', '"'..v..'". Replace with "'..dep_values[v]..'".' ) table.insert(res,p) end end returntable.concat(res) end returnp