Module:NUMBEROFSECTIONS
Appearance
| This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing. |
| This module is currently protected from editing. See the protection policy and protection log for more details. Please discuss any changes on the talk page; you may submit an edit request to ask an administrator to make an edit if it is uncontroversial or supported by consensus. You may also request that this page be unprotected. |
Usage
| This module is invoked by {{NUMBEROFSECTIONS}} |
sections{{ #invoke:NUMBEROFSECTIONS|main| page name [ # page name [ # ... ] ] | level = section level number(s) }}- Multiple page names (at least one required) are the
#delimited names of any Wikipedia pages (including namespaces). - section level(s) (required) is any group of numerals between 1 and 6 (inclusive) e.g.
435or5 3 4equates to:
- sections with a level
3( "===" ),4( "====" ) or5( "=====" ) heading.
- sections with a level
- Multiple page names (at least one required) are the
{{#invoke:NUMBEROFSECTIONS|main|Wikipedia:Village pump (technical)|level=2}}producesScript error: The function "main" does not exist.{{#invoke:NUMBEROFSECTIONS|main|Wikipedia:Village pump (technical)#Wikipedia:Village pump (proposals)|level=2}}producesScript error: The function "main" does not exist.
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[index]
-- 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[index]
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[#needles + 1] = "\n" ..
string.rep("=", tonumber(level)) .. "[^=]"
end
end
-- Otherwise, add the page name to our table
elseif value then
pages[#pages + 1] = value
end
end
-- For each page name in our table
page = pages[index]
while page do
-- get the raw markup
haystack = mw.title.new(page)
-- count the sections and add to the total
total = total + count(haystack:getContent(), needles)
index = index + 1
page = pages[index]
end
--[[ then return how many sections of the required level
are in all the pages passed ]]
return total
end
return p