Misplaced Pages

Revision as of 19:48, 8 December 2018

This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.

Usage

This module is invoked by {{NUMBEROFSECTIONS}}

sections

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

1. Multiple page names (at least one required) are the # delimited names of any Misplaced Pages 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|Misplaced Pages:Village pump (technical)|level=2}} produces Script error: The function "main" does not exist.

{{#invoke:NUMBEROFSECTIONS|main|Misplaced Pages:Village pump (technical)#Misplaced Pages:Village pump (proposals)|level=2}} produces Script error: The function "main" does not exist.

local p = {}

-- Unescape functionality grabbed from https://stackoverflow.com/a/14899740/1832568
local function unescape(str)
  str = string.gsub(str, '&#(%d+);', function(n) return string.char(n) end)
  str = string.gsub(str, '&#x(%d+);', function(n) return string.char(tonumber(n, 16)) end)
  return str
end

-- 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 haystack = ''
	-- Separate page names from # delimited string into table
	local pages = mw.text.split(unescape(frame.args), '%s?#%s?')
	-- Separate whitespace delimited section level numbers into table
	local levels = mw.text.split(frame.args, '%s*')
	-- Iterate through levels
	for level in mw.text.gsplit(table.concat(levels), '') do
		-- and add the level needle to needles
		needles = '\n'..string.rep('=', tonumber(level))..''
	end
	-- For each page name in pages
	for index, page in ipairs(pages) do
		-- create a haystack to search from the page content
		haystack = mw.title.new(page):getContent()
		-- If we've requested the content of a legitimate page
		if haystack then
			--[[ pass the raw markup and needles to count
				 and add the return to total ]]
			total = total + count(haystack, needles)
		end
	end
	--[[ then return how many sections of the required level
		 are in all the pages passed ]]
	return total
end

return p

• Modules subject to page protection