Module:Television infoboxes disambiguation check/doc

This is a documentation subpage for Module:Television infoboxes disambiguation check.
It may contain usage information, categories and other content that is not part of the original module page.

This Lua module is used on approximately 67,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them.

This module depends on the following other modules:

Module:Television infoboxes disambiguation check handles the validation of disambiguation of pages using a television-related infobox. Currently Module:Infobox television disambiguation check and Module:Infobox television season disambiguation check are setup to work with it.

Usage

local validateDisambiguation = require('Module:Television infoboxes disambiguation check')
local trackingCategory, debugString = validateDisambiguation.main(title, validDisambiguationTypeList, validDisambiguationPatternList, exceptionList, otherInfoboxList)

Parameter list

Parameter	Explanation	Status
`title`	The page's title.	required
`validDisambiguationTypeList`	An array of valid disambiguation types.	required
`validDisambiguationPatternList`	An array of DisambiguationPattern.	required
`exceptionList`	An array of page names that should not be validated; If there are none, pass an empty array.	required
`otherInfoboxList`	An array of key/value pairs of the type the disambiguation to check for (key) and the tracking category to add it to (value).	required