Module:Section sizes/doc

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's style= 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 _total as a percentage of _total rounded 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 }} →
• {{#invoke:Section sizes|section_size_get| Klingon language | Phonology | _all }} →

Keywords:

• {{#invoke:Section sizes|section_size_get| Klingon language | _lead }} →
• {{#invoke:Section sizes|section_size_get| Klingon language | _max }} →
• {{#invoke:Section sizes|section_size_get| Klingon language | _total }} →

Section sizes without thousands separator:

• {{#invoke:Section sizes|section_size_get| Klingon language | Phonology | _nosep=yes }} →
• {{#invoke:Section sizes|section_size_get| Klingon language | _total | _nosep=yes }} →

Section sizes as a percentage of _total:

• {{#invoke:Section sizes|section_size_get| Klingon language | Phonology | _pct=yes }} →
• {{#invoke:Section sizes|section_size_get| Klingon language | _lead | _pct=yes }} →
• {{#invoke:Section sizes|section_size_get| Klingon language | _max | _pct=yes }} →
• {{#invoke:Section sizes|section_size_get| Klingon language | _total | _pct=yes }} →

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