Difference between revisions of "Module:NUMBEROFSECTIONS"

From blackwiki
Jump to navigation Jump to search
blackwiki>Fred Gandt
(check for nil vals)
m (21 revisions imported)
 
(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[index]
 
 
-- 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[index]
 
 
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 = ''
-- Iterate through the args to find the page names and section levels
+
-- Separate page names from # delimited string into table
for key, value in pairs(frame.args) do
+
local pages = mw.text.split(unescape(frame.args[1]), '%s?#%s?')
-- If the param specifies the section levels required
+
-- Separate whitespace delimited section level numbers into table
if key == 'level' then
+
local levels = mw.text.split(frame.args['level'], '%s*')
-- for every section level number
+
-- Iterate through levels
for level in mw.text.gsplit(value, "") do
+
for level in mw.text.gsplit(table.concat(levels), '') do
if level ~= " " then
+
-- and add the level needle to needles
-- add the needle to our table of needles
+
needles[#needles + 1] = '\n'..string.rep('=', tonumber(level))..'[^=]'
needles[#needles + 1] = "\n" ..
 
string.rep("=", tonumber(level)) .. "[^=]"
 
end
 
end
 
-- Otherwise, add the page name to our table
 
else
 
pages[#pages + 1] = value
 
end
 
 
end
 
end
-- For each page name in our table
+
-- For each page name in pages
page = pages[index]
+
for index, page in ipairs(pages) do
while page do
+
-- create a haystack to search from the page content
-- get the raw markup
+
haystack = mw.title.new(page):getContent()
haystack = mw.title.new(page)
+
-- If we've requested the content of a legitimate page
 
if haystack then
 
if haystack then
-- count the sections and add to the total
+
--[[ pass the raw markup and needles to count
total = total + count(haystack:getContent(), needles)
+
and add the return to total ]]
 +
total = total + count('\n' .. haystack, needles)
 
end
 
end
index = index + 1
 
page = pages[index]
 
 
end
 
end
 
--[[ then return how many sections of the required level
 
--[[ then return how many sections of the required level

Latest revision as of 08:03, 27 September 2020

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 Template:NUMBEROFSECTIONS
{{#invoke:NUMBEROFSECTIONS|main|Wikipedia:Village pump (technical)#Wikipedia:Village pump (proposals)|level=2}} produces Template:NUMBEROFSECTIONS



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[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
		-- 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