Module:Is infobox in lead

Module documentation

This Lua module is used on approximately risk pages.

To avoid large-scale disruption and unnecessary server load, any changes to this module should first be tested in its /sandbox or /testcases subpages. The tested changes can then be added to this page in one single edit.

Please consider discussing any changes on the talk page before implementing them.

Module:Is infobox in lead checks if a given infobox is in the lead, is also the only infobox in the lead, and that there aren't two of that same infobox in the article. If that is the case, it returns true, and if not returns nothing.

This is designed for use by infoboxes that automatically generate short descriptions, to make sure they only generate a short description if they are the lead infobox.

Usage

{{#invoke:Is infobox in lead|main|[Ii]nfobox [Ff]oo [Bb]ar}}

It does not detect redirects which do not match the parameter. Redirects can be handled with an extra invocation per redirect pattern, e.g.:

{{#invoke:Is infobox in lead|main|[Ii]nfobox [Ss]ong}}{{#invoke:Is infobox in lead|main|[Ii]nfobox [Ss]ingle}}

Redirects can be found with WhatLinksHere.

local p = {}

function p.main (frame)
	return p._main (frame.args[1])
end

function p._main (searchString)
	local content = mw.title.getCurrentTitle():getContent()
	local offset = string.find(content, "==", 1 , true)
	if offset then
		local lead = string.sub(content, 1, offset-1)
		if (string.find(lead, searchString)) then
			lead = lead
				:gsub( "{{%s-[Ii]nfobox%s-mapframe", "") --don't check for infobox mapframe
				:gsub( "{{%s-[Ii]nfobo[^}]-%|%s-embed%s-=%s-yes", "") --don't check for embeded infoboxes
				:gsub( "{{%s-[Ii]nfobo[^}]-%|%s-child%s-=%s-yes", "") --don't check for child infoboxes
			local iter = string.gmatch(lead, "{{%s-[Ii]nfobox")
			iter()
			if not iter() then --if able to find two infoboxes in the lead, then don't return true
				local iter2 = string.gmatch(content, searchString)
				iter2()
				if not iter2() then --if able to find two of the specific infobox in the article, then don't return true
					return true
				end
			end
		end
	end
end

return p