Jump to content
Wikipedia The Free Encyclopedia

Module:Check for deprecated parameters/sandbox

From Wikipedia, the free encyclopedia
This is the module sandbox page for Module:Check for deprecated parameters (diff).
See also the companion subpage for test cases (run).
Module documentation[view] [edit] [history] [purge]
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.
Warning This Lua module is used on approximately 699,000 pages, or roughly 1% of all 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.
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.

For testing, see the output of the test cases. You should view that both normally and in preview mode to fully test the module.

Usage

[edit ]
{{#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
}}

Parameters

[edit ]
  • |_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_

See also

[edit ]
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 (edit | run) pages.
Add categories to the /doc subpage. 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={}

 localfunctionisnotempty(s)
 returnsandmw.text.trim(s)~=''
 end

 localfunctionscanValues(values,results,args,replaceTable)
 fork,vinpairs(values)do
 localc=args.category:gsub('_VALUE_',v)
 table.insert(results,c)
 ifv==''then
 -- Fix odd bug for | = which gets stripped to the empty string
 -- and breaks category links
 v=' '
 end
 localreplaceString='"'..v..'". '
 localreplaceValue=replaceTableandreplaceTable[v]
 replaceString=replaceString..(replaceValueand'Replace with "'..replaceValue..'".'or'It should be removed.')
 localp=args.preview:gsub('_VALUE_',replaceString)
 table.insert(results,p)
 end
 end

 functionp.check(frame)
 -- create the table of deprecated values and their matching new value
 returnp._check(frame.args,frame:getParent().args,frame:getParent():getTitle())
 end

 localmoduleParams={ignoreblank=true,preview=true,_category=true,_remove=true}

 functionp._check(args,pargs,caller)
 localdep_values={}
 fork,vinpairs(args)do
 ifnotmoduleParams[k]then
 dep_values[k]=v
 end
 end

 -- Parse params to remove
 localremoves={}
 ifargs['_remove']then
 forrinargs['_remove']:gmatch("([^;]+)")do
 removes[mw.text.trim(r)]=1
 end
 end

 -- loop over the parent args and see if any are deprecated
 localvalues={}
 localremove_values={}
 localignoreblank=isnotempty(args['ignoreblank'])
 fork,vinpairs(pargs)do
 ifnotignoreblankorisnotempty(v)then
 ifdep_values[k]then
 table.insert(values,k)
 elseifremoves[k]then
 table.insert(remove_values,k)
 end
 end
 end

 -- find out about calling context
 localtitle=mw.title.getCurrentTitle()

 -- create local defaulted arguments
 localcategory=args["_category"]ortitle.namespace==0and"[[Category:Pages with deprecated parameters]]"or""
 localpreview=args['preview']or'Page using [['..caller..']] with deprecated parameter _VALUE_'
 ifisnotempty(preview)then
 preview=require('Module:If preview')._warning({preview})
 end
 locallocalArgs={category=category,preview=preview}

 -- scan through values and remove_values and create output results
 localresults={}
 scanValues(values,results,localArgs,dep_values)
 scanValues(remove_values,results,localArgs)
 returntable.concat(results)
 end

 returnp

AltStyle によって変換されたページ (->オリジナル) /