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.

This module has two entry points: size, and section_size_get.

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}}

{{#invoke:Section sizes|size|Klingon language}}

Section sizes in Klingon language Section size for Klingon language (25 sections) Section name Byte count Prose size (words) Header Total Header Total (Top) 5,510 5,510 293 293 History 14 8,457 0 610 Creation 4,226 4,226 292 292 Internal history 1,341 1,341 147 147 Canonicity 2,876 2,876 171 171 Language usage 21 23,960 0 1,381 Speakers 7,429 7,429 500 500 Translated works 2,600 2,600 254 254 Real world usage 1,581 1,581 69 69 Use in other media 7,428 7,428 365 365 Learning resources 4,901 4,901 193 193 Phonology 4,919 12,818 201 685 Consonants 3,052 3,052 80 80 Vowels 3,153 3,153 179 179 Syllable structure 773 773 86 86 Stress 921 921 139 139 Grammar 3,827 3,827 448 448 Writing systems 4,880 4,880 512 512 Vocabulary 1,893 1,893 192 192 Example sentences 809 809 0 0 See also 176 176 0 0 Notes 26 26 0 0 References 30 30 0 0 Bibliography 910 910 0 0 External links 3,145 3,145 0 0 Total 66,441 66,441 4,121 4,121

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

• |_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

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 }} → 4,919
• {{#invoke:Section sizes|section_size_get| Klingon language | Phonology | _all }} → 12,818

Keywords:

• {{#invoke:Section sizes|section_size_get| Klingon language | _lead }} → 5,510
• {{#invoke:Section sizes|section_size_get| Klingon language | _max }} → 7,429
• {{#invoke:Section sizes|section_size_get| Klingon language | _total }} → 66,441

Section sizes without thousands separator:

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

Section sizes as a percentage of _total:

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

• 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