Misplaced Pages

Module:NUMBEROFSECTIONS

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.

This is an old revision of this page, as edited by Fred Gandt (talk | contribs) at 09:42, 25 March 2016 (check for nil vals). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

Revision as of 09:42, 25 March 2016 by Fred Gandt (talk | contribs) (check for nil vals)(diff) ← Previous revision | Latest revision (diff) | Newer revision → (diff) 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 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.
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 = {}

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

-- Function accepting any number of page names and section level numbers
function p.sections(frame)
	local index = 1
	local total = 0
	local page = ""
	local pages = {}
	local needles = {}
	local haystack = ""
	-- Iterate through the args to find the page names and section levels
	for key, value in pairs(frame.args) do
		-- If the param specifies the section levels required
		if key == 'level' then
			-- for every section level number
			for level in mw.text.gsplit(value, "") do
				if level ~= " " then
					-- 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
	-- For each page name in our table
	page = pages
	while page do
		-- get the raw markup
		haystack = mw.title.new(page)
		if haystack then
			-- count the sections and add to the total
			total = total + count(haystack:getContent(), needles)
		end
		index = index + 1
		page = pages
	end
	--[[ then return how many sections of the required level
		 are in all the pages passed ]]
	return total
end

return p
Category: