Module:NUMBEROFSECTIONS/sandbox: Difference between revisions

Module documentation[view] [edit] [history] [purge]

Usage

sections

{{ #invoke:NUMBEROFSECTIONS|main| page name [ # page name [ # ... ] ] | level = section level number(s) }}

1. Multiple page names (at least one required) are the # delimited names of any Wikipedia pages (including namespaces).
2. section level(s) (required) is any group of numerals between 1 and 6 (inclusive) e.g. 435 or 5 3 4 equates to:

sections with a level 3 ( "===" ), 4 ( "====" ) or 5 ( "=====" ) heading.

{{#invoke:NUMBEROFSECTIONS|main|Wikipedia:Village pump (technical)|level=2}} produces 25

{{#invoke:NUMBEROFSECTIONS|main|Wikipedia:Village pump (technical)#Wikipedia:Village pump (proposals)|level=2}} produces 38

The above documentation is transcluded from Module:NUMBEROFSECTIONS/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this module.

local p = {}

-- Counting function accepting a string haystack and table of needles
local function count(haystack, needles)
	local number = 0
	-- While we have needles to look for
	for index, needle in ipairs(needles) do
		-- find them all in our haystack
		for m in string.gmatch(haystack, needle) do
			number = number + 1
		end
	end
	return number
end

-- Function takes any number of # delimited page names and section level numbers
function p.sections(frame)
	local total = 0
	local needles = {}
	local title_obj = ""
	-- Separate page names from # delimited string into table
	local pages = mw.text.split(frame.args[1], '%s?#%s?')
	-- Separate whitespace delimited section level numbers into table
	local levels = mw.text.split(frame.args['level'], '%s*')
	-- Iterate through levels
	for level in mw.text.gsplit(table.concat(levels), '') do
		-- and add the level needle to needles
		needles[#needles + 1] = '\n'..string.rep('=', tonumber(level))..'[^=]'
	end
	-- For each page name in pages
	for index, page in ipairs(pages) do
		title_obj = mw.title.new(page)
		-- if we've requested the content of a legitimate page
		if title_obj ~= nil then
			--[[ pass the raw markup and needles to count
				 and add the return to total ]]
			total = total + count(title_obj:getContent(), needles)
		end
	end
	--[[ then return how many sections of the required level
		 are in all the pages passed ]]
	return total
end

return p