Knowledge

Module:Check for unknown parameters/doc

Source 📝

31: 68: 111: 342:
keyword, if used, will be changed to the name of the parameter. This is useful for either sorting the entries in a tracking category, or for provide more explicit information.
139:
is used to check for uses of unknown parameters in a template or module. It may be appended to a template at the end or called directly from a module.
304: 329:– what happens when an uknown parameter is used. Typically use either a tracking category to place pages that use unknown parameters, or an error. 89: 85: 77: 348:– by default, the module makes no distinction between a defined-but-blank parameter and a non-blank parameter. That is, both unlisted 97: 626: 620: 666: 632: 605: 200: 186: 172: 158: 46: 17: 274:
Where the first set of args are the module args below and the second set of args are the parameters that are checked.
189:|check|unknown=<span class="error">Sorry, I don't recognize _VALUE_</span>|arg1|arg2|...|argN}} 38: 203:|check|unknown=]|preview=unknown parameter "_VALUE_"|arg1|arg2|...|argN|regexp1=header+|regexp2=date}} 660: 598: 124: 52: 654: 96:. The tested changes can be added to this page in a single edit. Please discuss changes on the 166:
To sort the entries into a tracking category by parameter with a preview error message, use:
8: 644: 582: 84:
To avoid major disruption and server load, any changes should be tested in the module's
638: 308: 41: 323:). This is useful when there are many known parameters which use a systematic pattern. 648: 120: 578: 366:– by default, the module ignores blank positional parameters. That is, an unlisted 175:|check|unknown=]|preview=unknown parameter "_VALUE_"|arg1|arg2|...|argN}} 335:– the text to be displayed when in preview mode and an unknown parameter is used. 93: 614: 82:
Changes to it can cause immediate changes to the Knowledge user interface.
586: 78:
approximately 21,300,000 pages, or roughly 35% of all pages
55:
and other content that is not part of the original module page.
152:
To sort entries into a tracking category by parameter, use:
651:– generates a list of parameter names for a given template 629:– similar module that checks for deprecated parameters 356:
are reported. To only track non-blank parameters use
311:) usage with parameters is also supported (such as: 623:– adds documentation to templates using this module 116:
This module depends on the following other modules:
669:- A tool for checking usage of template parameters 297:Unnamed (positional) parameters can be added too: 374:blank positional parameters in the tracking use 161:|check|unknown=]|arg1|arg2|arg3|argN}} 635:– module that checks for conflicting parameters 233:"Module:Check for unknown parameters" 617:– for complex operations involving parameters 572: 641:– similar function (originally from dewiki) 601: (274) (category page can have header 74:This Lua module is used in system messages 180:For an explicit red error message, use: 14: 627:Module:Check for deprecated parameters 621:Template:Checks for unknown parameters 549:unknown parameter "_VALUE_" 667:User:Bamyers99/TemplateParametersTool 633:Module:Check for clobbered parameters 201:#invoke:Check for unknown parameters 187:#invoke:Check for unknown parameters 173:#invoke:Check for unknown parameters 159:#invoke:Check for unknown parameters 105: 62: 25: 657:based template parameter validation 137:Module:Check for unknown parameters 47:Module:Check for unknown parameters 23: 18:Module:Check for unknown parameters 147: 61: 51:It may contain usage information, 679: 589:for more complicated examples. 208: 109: 66: 29: 376:|showblankpositional=1 364:|showblankpositional=1 13: 1: 277: 517:Check for unknown parameters 213:To call from a module, use: 7: 661:Module:Parameter validation 606:Unknown parameters category 599:Category:Unknown parameters 592: 503:end infobox, start tracking 294:, are the known parameters. 10: 684: 382: 194:To use Lua patterns, use: 573:Call from within Lua code 313:|regexp1=header+ 248:checkForUnknownParameters 221:checkForUnknownParameters 100:before implementing them. 92:subpages, or in your own 581:for a simple example or 386: 321:|regexp3=data+? 215: 142: 358:|ignoreblank=1 346:|ignoreblank=1 317:|regexp2=date 655:Project:TemplateData 645:Template:Parameters 583:Module:Infobox3cols 309:regular expressions 639:Module:TemplatePar 333:|preview= 327:|unknown= 299:|1|2|arg1|arg2|... 44: 663:checks a lot more 649:Module:Parameters 134: 133: 121:Module:If preview 104: 103: 59: 58: 36: 675: 610: 604: 579:Module:Rugby box 568: 564: 560: 556: 552: 548: 545: 542: 539: 536: 533: 530: 527: 524: 520: 516: 513: 510: 507: 504: 501: 498: 495: 492: 489: 486: 483: 480: 476: 473: 470: 467: 464: 461: 458: 455: 452: 448: 445: 442: 439: 436: 433: 430: 427: 424: 420: 417: 414: 411: 408: 405: 402: 399: 396: 393: 390: 377: 369: 365: 359: 355: 351: 347: 341: 334: 328: 322: 318: 314: 300: 293: 289: 285: 270: 267: 264: 261: 258: 255: 252: 249: 246: 243: 240: 237: 234: 231: 228: 225: 222: 219: 204: 190: 176: 162: 113: 112: 106: 70: 69: 63: 33: 32: 26: 683: 682: 678: 677: 676: 674: 673: 672: 608: 602: 595: 577:See the end of 575: 570: 569: 566: 562: 558: 554: 550: 546: 543: 540: 537: 534: 531: 528: 525: 522: 518: 514: 511: 508: 505: 502: 499: 496: 493: 490: 487: 484: 481: 478: 474: 471: 468: 465: 462: 459: 456: 453: 450: 446: 443: 440: 437: 434: 431: 428: 425: 422: 418: 415: 412: 409: 406: 403: 400: 397: 394: 391: 388: 385: 375: 370:is ignored. To 367: 363: 357: 353: 350:|foo=x 349: 345: 339: 332: 326: 320: 316: 312: 298: 291: 287: 283: 280: 272: 271: 268: 265: 262: 259: 256: 253: 250: 247: 244: 241: 238: 235: 232: 229: 226: 223: 220: 217: 211: 198: 184: 170: 156: 150: 148:From a template 145: 130: 110: 83: 81: 67: 60: 50: 30: 22: 21: 20: 12: 11: 5: 681: 671: 670: 664: 658: 652: 642: 636: 630: 624: 618: 612: 594: 591: 574: 571: 387: 384: 381: 380: 379: 373: 361: 354:|foo= 343: 336: 330: 324: 302: 295: 279: 276: 216: 210: 207: 206: 205: 192: 191: 178: 177: 164: 163: 149: 146: 144: 141: 132: 131: 129: 128: 117: 114: 102: 101: 94:module sandbox 71: 57: 56: 34: 24: 15: 9: 6: 4: 3: 2: 680: 668: 665: 662: 659: 656: 653: 650: 646: 643: 640: 637: 634: 631: 628: 625: 622: 619: 616: 615:Module:Params 613: 607: 600: 597: 596: 590: 588: 584: 580: 371: 362: 344: 337: 331: 325: 310: 306: 303: 296: 282: 281: 275: 214: 209:From a module 202: 197: 196: 195: 188: 183: 182: 181: 174: 169: 168: 167: 160: 155: 154: 153: 140: 138: 126: 122: 119: 118: 115: 108: 107: 99: 95: 91: 87: 79: 75: 72: 65: 64: 54: 48: 43: 40: 39:documentation 35: 28: 27: 19: 609:}} 603:{{ 576: 368:|2= 307:(similar to 305:Lua patterns 273: 212: 199:{{ 193: 185:{{ 179: 171:{{ 165: 157:{{ 151: 136: 135: 73: 587:Module:Flag 535:Main other 278:Parameters 90:/testcases 53:categories 37:This is a 260:validArgs 98:talk page 76:, and on 593:See also 565:weight 561:website 544:preview 526:unknown 500:<!-- 477:Website 86:/sandbox 553:height 512:#invoke 491:website 472:label3 449:Weight 444:label2 421:Height 416:label1 392:Infobox 383:Example 372:include 340:_VALUE_ 290:, ..., 227:require 125:sandbox 42:subpage 521:check 506:--> 482:data3 463:weight 454:data2 435:height 426:data1 398:above 254:_check 242:result 557:name 239:local 218:local 143:Usage 16:< 647:and 538:|]}} 494:|}}} 466:|}}} 438:|}}} 410:|}}} 407:name 352:and 338:The 292:argN 288:arg2 284:arg1 266:args 45:for 585:or 488:{{{ 460:{{{ 432:{{{ 404:{{{ 88:or 567:}} 532:{{ 509:{{ 497:}} 389:{{ 319:, 315:, 286:, 611:) 563:| 559:| 555:| 551:| 547:= 541:| 529:= 523:| 519:| 515:: 485:= 479:| 475:= 469:| 457:= 451:| 447:= 441:| 429:= 423:| 419:= 413:| 401:= 395:| 378:. 360:. 301:. 269:) 263:, 257:( 251:. 245:= 236:) 230:( 224:= 127:) 123:( 80:. 49:.

Index

Module:Check for unknown parameters
documentation
subpage
Module:Check for unknown parameters
categories
approximately 21,300,000 pages, or roughly 35% of all pages
/sandbox
/testcases
module sandbox
talk page
Module:If preview
sandbox
#invoke:Check for unknown parameters
#invoke:Check for unknown parameters
#invoke:Check for unknown parameters
#invoke:Check for unknown parameters
Lua patterns
regular expressions
Module:Rugby box
Module:Infobox3cols
Module:Flag
Category:Unknown parameters
Unknown parameters category
Module:Params
Template:Checks for unknown parameters
Module:Check for deprecated parameters
Module:Check for clobbered parameters
Module:TemplatePar
Template:Parameters
Module:Parameters

Text is available under the Creative Commons Attribution-ShareAlike License. Additional terms may apply.