Misplaced Pages

Module:NUMBEROFSECTIONS: Difference between revisions

Article snapshot taken from Wikipedia with creative commons attribution-sharealike license. Give it a read and then ask your questions in the chat. We can research this topic together.
Browse history interactively← Previous editContent deleted Content added
Revision as of 09:42, 25 March 2016 view sourceFred Gandt (talk | contribs)Extended confirmed users, New page reviewers, Template editors15,110 edits check for nil vals← Previous edit Latest revision as of 21:15, 4 February 2023 view source Fred Gandt (talk | contribs)Extended confirmed users, New page reviewers, Template editors15,110 edits slight improvement for handling unexpected-and-wanted whitespace around the # delimiters; %s? --> %s* i.e. possible single whitespace char --> zero or more whitespace chars 
(15 intermediate revisions by 6 users not shown)
Line 1: Line 1:
local p = {} local p = {}

-- Unescape functionality grabbed from https://stackoverflow.com/a/14899740/1832568
local function unescape(str)
str = string.gsub(str, '&#(%d+);', string.char)
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 -- Counting function accepting a string haystack and table of needles
local function count(haystack, needles) local function count(haystack, needles)
local number = 0 local number = 0
local index = 1
local needle = needles
-- While we have needles to look for -- While we have needles to look for
while needle do for index, needle in ipairs(needles) do
-- find them all in our haystack -- find them all in our haystack
for m in string.gmatch(haystack, needle) do for m in string.gmatch(haystack, needle) do
number = number + 1 number = number + 1
end end
index = index + 1
needle = needles
end end
return number return number
end end


-- Function accepting any number of page names and section level numbers -- Function takes any number of # delimited page names and section level numbers
function p.sections(frame) function p.main(frame)
local index = 1
local total = 0 local total = 0
local page = ""
local pages = {}
local needles = {} local needles = {}
local haystack = "" local haystack = ''
-- Separate page names from # delimited string into table
-- Iterate through the args to find the page names and section levels
for key, value in pairs(frame.args) do local pages = mw.text.split(unescape(frame.args), '%s*#%s*')
-- Separate whitespace delimited section level numbers into table
-- If the param specifies the section levels required
if key == 'level' then local levels = mw.text.split(frame.args, '%s*')
-- Iterate through levels
-- for every section level number
for level in mw.text.gsplit(value, "") do for level in mw.text.gsplit(table.concat(levels), '') do
-- and add the level needle to needles
if level ~= " " then
needles = '\n'..string.rep('=', tonumber(level))..''
-- add the needle to our table of needles
needles = "\n" ..
string.rep("=", tonumber(level)) .. ""
end
end
-- Otherwise, add the page name to our table
else
pages = value
end
end end
-- For each page name in our table -- For each page name in pages
page = pages for index, page in ipairs(pages) do
-- create a haystack to search from the page content
while page do
haystack = mw.title.new(page):getContent()
-- get the raw markup
-- If we've requested the content of a legitimate page
haystack = mw.title.new(page)
if haystack then if haystack then
-- count the sections and add to the total --[[ pass the raw markup and needles to count
and add the return to total ]]
total = total + count(haystack:getContent(), needles) total = total + count('\n' .. haystack, needles)
end end
index = index + 1
page = pages
end end
--[[ then return how many sections of the required level --[[ then return how many sections of the required level

Latest revision as of 21:15, 4 February 2023

Module documentation[view] [edit] [history] [purge]
ProtectedThis 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

CautionThis 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 22
{{#invoke:NUMBEROFSECTIONS|main|Misplaced Pages:Village pump (technical)#Misplaced Pages:Village pump (proposals)|level=2}} produces 36
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.
Subpages of this module.

local p = {}

-- Unescape functionality grabbed from https://stackoverflow.com/a/14899740/1832568
local function unescape(str)
	str = string.gsub(str, '&#(%d+);', string.char)
	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.main(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('\n' .. haystack, needles)
		end
	end
	--[[ then return how many sections of the required level
		 are in all the pages passed ]]
	return total
end

return p
Category: