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 Alex 21 (talk | contribs) at 03:35, 1 April 2016 (Return 0 for non-existent articles). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

Revision as of 03:35, 1 April 2016 by Alex 21 (talk | contribs) (Return 0 for non-existent articles)(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
	if (haystack == nil) then
		return number
	end
	-- 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, '%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
		title_obj = mw.title.new(page)
		-- if we've request the content of a legitimate page
		if title_obj 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
Category: