This module creates a wikitable that lists each section in a page along with that section's size in bytes. Each section is wikilinked to its target in the page; subsections are indented. Cells for section sizes are shaded according to the size; the smallest section's background is white, and the largest section's background is red.
Usage
This module has two entry points: size, and section_size_get.
size
Use entry point size to emit the section wikitable:
{{#invoke:Section sizes|size|<page name>|style=<style string>}}
Entry point size() takes two arguments from frame, one positional and one named:
<page name>(required) – the first positional parameter is the page name; may include namespace|style=(optional) – css string suitable for use in the wikitable'sstyle=attribute; for example to render the table at the right side of the page:{{#invoke:Section sizes|size|<page name>|style=float:right; margin-left:.5em}}
Example
{{#invoke:Section sizes|size|Klingon language}}
 |
|
section_size_get
section_size_get return an article or section size statistic:
{{#invoke:Section sizes|section_size_get|<page name>|[<section name|token>]|_all|_pct=yes |_nosep=yes}}
section_size_get takes one to three positional parameters and two named parameters from frame:
<page name>(required) – the first positional parameter is the page name; may include namespace<section name|token>(optional) – the second positional parameter is either the section name, or one of three tokens (if param 2 is absent, the default is the article's lead section)<section name>– returns the size of the named section_lead– returns the size of the lead section; default when second positional parameter is empty or omitted_max– returns the size of the longest individual section_total– returns the size of the article (should equal PAGESIZE)
_all(optional) – the third positional parameter is the scope of the size measure; requires<section name>; not supported for keywords; returns size of the named section plus the sizes of its subsections
Named parameters
|_nosep=(optional) – no separator; accepts one value:yes; section size emitted without thousands separators; ignored when|_pct=is set (default: with separator)|_pct=(optional) – percent; accepts one value:yes; emits size of<section name>,_lead,_max, or_totalas a percentage of_totalrounded to 2 decimals with a '%' symbol
Examples
These examples refer to the same article as shown in the size example.
Sizes of a named section with and without its subsections (_all):
{{#invoke:Section sizes|section_size_get| Klingon language | Phonology }}→ error: no article: Klingon language (help){{#invoke:Section sizes|section_size_get| Klingon language | Phonology | _all }}→ error: no article: Klingon language (help)
Keywords:
{{#invoke:Section sizes|section_size_get| Klingon language | _lead }}→ error: no article: Klingon language (help){{#invoke:Section sizes|section_size_get| Klingon language | _max }}→ error: no article: Klingon language (help){{#invoke:Section sizes|section_size_get| Klingon language | _total }}→ error: no article: Klingon language (help)
Section sizes without thousands separator:
{{#invoke:Section sizes|section_size_get| Klingon language | Phonology | _nosep=yes }}→ error: no article: Klingon language (help){{#invoke:Section sizes|section_size_get| Klingon language | _total | _nosep=yes }}→ error: no article: Klingon language (help)
Section sizes as a percentage of _total:
{{#invoke:Section sizes|section_size_get| Klingon language | Phonology | _pct=yes }}→ error: no article: Klingon language (help){{#invoke:Section sizes|section_size_get| Klingon language | _lead | _pct=yes }}→ error: no article: Klingon language (help){{#invoke:Section sizes|section_size_get| Klingon language | _max | _pct=yes }}→ error: no article: Klingon language (help){{#invoke:Section sizes|section_size_get| Klingon language | _total | _pct=yes }}→ error: no article: Klingon language (help)
See also
- Template:Section sizes, a pre-styled template for talk pages which invokes this module
- Template:Section length, a simple template which invokes it to request the length of one named section, or related info
require('strict');
--[=[-------------------------< R E M O V E _ W I K I _ L I N K >----------------------------------------------
Gets the display text from a wikilink like [[A|B]] or [[B]] gives B
The str:gsub() returns either A|B froma [[A|B]] or B from [[B]] or B from B (no wikilink markup).
In l(), l:gsub() removes the link and pipe (if they exist); the second :gsub() trims white space from the label
if str was wrapped in wikilink markup. Presumably, this is because without wikimarkup in str, there is no match
in the initial gsub, the replacement function l() doesn't get called.
]=]
local function remove_wiki_link (str)
return (str:gsub( "%[%[([^%[%]]*)%]%]", function(l)
return l:gsub( "^[^|]*|(.*)$", "%1" ):gsub("^%s*(.-)%s*$", "%1");
end));
end
--[=[ Inspired from above, removes everything between < & >
Used to remove html containers from headers to fix breaking section links, but legitimate text within < & > are removed too
]=]
local function remove_container (str)
return (str:gsub( "%<([^%>]*)%>", function(l)
return l:gsub("^%s*(.-)%s*$", "");
end));
end
--[=[-------------------------< M A K E _ W I K I L I N K >----------------------------------------------------
Makes a wikilink; when both link and display text is provided, returns a wikilink in the form [[L|D]]; if only
link is provided, returns a wikilink in the form [[L]]; if neither are provided or link is omitted, returns an
empty string.
]=]
local function make_wikilink (link, display)
if link and ('' ~= link) then
if display and ('' ~= display) then
return table.concat ({'[[', link, '|', display, ']]'});
else
return table.concat ({'[[', link, ']]'});
end
end
return display or ''; -- link not set so return the display text
end
--[[--------------------------< S I Z E >----------------------------------------------------------------------
module entry point
create a wikilinked list of <article name>'s sections and their size in bytes in a sortable wikitable
{{#invoke:Section sizes|size|<article name>}}
]]
local function size (frame)
local A = {}; -- table to hold section names and sizes
local section_name_list = {} -- an interim list that holds just the section names
local section_content; -- section content used for counting
local section = mw.title.new ("MediaWiki:Vector-toc-beginning"):getContent(); -- lead section doen't have a heading, call the text in MediaWiki:Vector-toc-beginning instead
local count = {}; -- number of bytes in a section including the header text
local totcount = {};
local lastlevel;
local maxlevels;
local levelcounts = {};
local upperlevel;
local highlight;
local highlighttot;
local total; -- sum of all byte counts
local max; -- largest section so far encountered
local totmax; -- largest section so far encountered (section total)
local _; -- dummy for using gsub to count bytes
local lang = mw.language.getContentLanguage(); -- language object for number formatting appropriate to local language
local s; -- start position of found heading (returned from string.find())
local e = 1; -- end position of found heading (returned from string.find())
local section_name; -- captured heading name (returned from string.find())
local level = {}; -- number of leading '=' in heading markup; used for indenting subsections in the rendered list
local wl_name; -- anchor and display portion for wikilinks in rendered list
local content = mw.title.new (frame.args[1]):getContent(); -- get unparsed wikitext from the article
if not content then
return '<span style="font-size:100%;" class="error">error: no article:' .. frame.args[1] .. '</span>';
end
if content:find ('#REDIRECT') then -- redirects don't have sections
return '<span style="font-size:100%;" class="error">error: ' .. frame.args[1] .. ' is a redirect</span>';
end
section_content = content:match ('(.-)===*'); -- get the lead section
if section_content then
_, count[0] = section_content:gsub ('.', '%1'); -- count the size of the lead section
else
return '<span style="font-size:100%;" class="error">error: no sections found in: ' .. frame.args[1] .. '</span>';
end
total = count[0];
max = count[0];
table.insert (A, make_wikilink (frame.args[1], section) .. '|| style="text-align:right"|' .. lang:formatNum (count[0]) .. '|| style="text-align:right"|' .. lang:formatNum (count[0]));
while (1) do -- done this way because some articles reuse section names
s, e, section_name = string.find (content, '\n==+ *(.-) *==+', e); -- get start, end, and section name beginning a end of last find; newline must precede '==' heading markup
if s then
table.insert (section_name_list, {section_name, s}); -- save section name and start location of this find
else
break;
end
end
for i, section_name in ipairs (section_name_list) do
local escaped_section_name = string.gsub (section_name[1], '([%(%)%.%%%+%-%*%?%[%^%$%]])', '%%%1'); -- escape lua patterns in section name
local pattern = '(==+ *' .. escaped_section_name .. ' *==+.-)==+'; -- make a pattern to get the content of a section
section_content = string.match (content, pattern, section_name[2]); -- get the content beginning at the string.find() start location
if section_content then
_, count[i] = section_content:gsub ('.', '%1'); -- count the bytes in the section
total = total + count[i];
max = max < count[i] and count[i] or max; -- keep track of largest count
else -- probably the last section (no proper header follows this section name)
pattern = '(==+ *' .. escaped_section_name .. ' *==+.+)'; -- make a new pattern
section_content = string.match (content, pattern, section_name[2]); -- try to get content
if section_content then
_, count[i] = section_content:gsub ('.', '%1'); -- count the bytes in the section
total = total + count[i];
max = max < count[i] and count[i] or max; -- keep track of largest count
else
count[i] = '—'; -- no content so show that
end
end
_, level[i] = section_content:find ('^=+'); -- should always be the first n characters of section content
end
totmax=0;
lastlevel=0;
maxlevels=7;
for j=1,maxlevels do
levelcounts[j]=0;
end
for i=#count,1,-1 do
--totcount[i]=level[i];
if level[i]<lastlevel then -- reset all
totcount[i]=levelcounts[level[i]]+count[i];
for j=level[i],maxlevels do
levelcounts[j]=0;
end
end
if level[i]>=lastlevel then
totcount[i]=count[i];
end
if level[i]>0 then
upperlevel=level[i]-1;
levelcounts[upperlevel]=levelcounts[upperlevel]+totcount[i];
end
lastlevel=level[i];
if totcount[i]>totmax then
totmax=totcount[i];
end
end
for i, section_name in ipairs (section_name_list) do
if count[i]==max then
highlight='color:red;"|';
else
highlight='"|';
end
highlighttot=''; -- start the style declaration
if level[i]==2 then
highlighttot=highlighttot .. 'font-weight:bold;'; -- if main section, make it bold
elseif totcount[i]==count[i] then
highlighttot='color:transparent;'; -- hide totals for subsections with no subsubsections, values required for proper sorting
end
if totcount[i]==totmax then
highlighttot=highlighttot .. 'color:red;'; -- if the largest size, make it red
end
highlighttot=highlighttot .. '"|'; -- close the style declaration
level[i] = (2 < level[i]) and ((level[i]-2) * 1.6) or nil; -- remove offset and mult by 1.6em (same indent as ':' markup which doesn't work in a table)
wl_name = remove_wiki_link (section_name[1]):gsub ('%b{}', ''); -- remove wikilinks and templates from section headings so that we can link to the section
wl_name = remove_container (wl_name); -- remove html containers from section headings so that we can link to the section
wl_name = wl_name:gsub ('[%[%]]', {['[']='[', [']']=']'}); -- replace '[' and ']' characters with html entities so that wikilinked section names work
wl_name = mw.text.trim (wl_name); -- trim leading/trailing white space if any because white space buggers up url anchor links
table.insert (A, table.concat ({ -- build most of a table row here because here we have heading information that we won't have later
level[i] and '<span style="margin-left:' .. level[i] .. 'em">' or ''; -- indent per heading level (number of '=' in heading markup)
make_wikilink (frame.args[1] .. '#' .. wl_name, wl_name), -- section link
level[i] and '</span>' or '', -- close the span if opened
'||', -- table column separator
'style="text-align:right;', -- the byte count column is right aligned
highlight ,
lang:formatNum (count[i]), -- commafied byte count for section
'||',
'style="text-align:right;', -- the section total column is right aligned
highlighttot ,
lang:formatNum (totcount[i]), -- section total count!!
}));
end
local out = {}; -- make a sortable wikitable for output
table.insert (out, string.format ('{| class="wikitable sortable" style="%s"\n|+Section size for [[%s]] (%d sections)', frame.args.style or '', frame.args[1], #A)); -- output table header
table.insert (out, '\n!Section name!!Byte<br/>count!!Section<br/>total\n|-\n|'); -- column headers, and first row pipe
table.insert (out, table.concat (A, '\n|-\n|')); -- section rows with leading pipes (except first row already done)
table.insert (out, '\n|-\n!Total!!style="text-align:right"|' .. lang:formatNum (total) .. '!!style="text-align:right"|' .. lang:formatNum (total)); -- total number of bytes counted as column headers so that sorting doesn't move this row from the bottom to top
table.insert (out, '\n|}'); -- close the wikitable
--max = lang:formatNum (max); -- commafy so that the commafied value in the table can be found
--local result = table.concat (out, ''):gsub (max, '<span style="color:red">' .. max .. '</span>'); -- make a big string, make largest count(s) red, and done
local result = table.concat (out, '');
return result; -- because gsub returns string and number of replacements
end
--[[--------------------------< E X P O R T E D F U N C T I O N S >------------------------------------------
]]
return
{
size = size,
}