Module:Section sizes/doc - Revision history

Mathglot: /* Usage */ Change 1st sentence to agree with new term section_size_get.

2024-09-22T21:21:37Z

Usage: Change 1st sentence to agree with new term section_size_get.

← Previous revision		Revision as of 21:21, 22 September 2024
Line 2:		Line 2:

	== Usage ==		== Usage ==
	This module has two entry points: <code>size</code>, and <code>~~section_length_get~~</code>.		This module has two entry points: <code>size</code>, and <code>section_size_get</code>.

	=== <code>size</code> ===		=== <code>size</code> ===

Trappist the monk: /* section_length_get */ ce;

2024-09-22T19:58:10Z

section_length_get: ce;

← Previous revision		Revision as of 19:58, 22 September 2024
Line 16:		Line 16:
	{{section sizes\|Klingon language}}		{{section sizes\|Klingon language}}

	=== <code>~~section_length_get~~</code> ===		=== <code>section_size_get</code> ===

	~~: Use entry point~~ <code>~~section_length_get~~</code> to return an article or section ~~length~~ statistic:		<code>section_size_get</code> return an article or section size statistic:
	<code>{{((}}#invoke:{{BASEPAGENAME}}\|~~section_length_get~~\|<{{var\|page name}}>\|<{{var\|section name}}>}}</code>~~{{br}}~~		:<code>{{((}}#invoke:{{BASEPAGENAME}}\|section_size_get\|<{{var\|page name}}>\|[<{{var\|section name}}{{!}}{{var\|token}}>]\|_all\|_pct=yes \|_nosep=yes}}</code>
	<code>{{((}}#invoke:{{BASEPAGENAME}}\|section_length_get\|<{{var\|page name}}>\|<{{var\|section name}}> \|_all}}</code>{{br}}
	<code>{{((}}#invoke:{{BASEPAGENAME}}\|section_length_get\|<{{var\|page name}}>\|<{{var\|section name}}> \|_all \|_pct=yes \|_nosep=yes}}</code>{{br}}
	<code>{{((}}#invoke:{{BASEPAGENAME}}\|section_length_get\|<{{var\|page name}}>\|<{{var\|token}}>}}</code>{{br}}

	~~Entry point~~ <code>~~section_length_get()~~</code> takes one to three positional ~~arguments~~ from <code>frame</code>~~, and two named arguments~~:		<code>section_size_get</code> takes one to three positional parameters and two named parameters from <code>frame</code>:
	:<code><{{var\|page name}}></code> (required) – the first positional parameter is the page name; may include namespace		*<code><{{var\|page name}}></code> (required) – the first positional parameter is the page name; may include namespace
	:<code><{{var\|section name}}></code> (optional) – the second positional parameter is either the section name, or one of three tokens (if param 2 is absent, the default is ~~_lead~~)		*<code><{{var\|section name}}{{!}}{{var\|token}}></code> (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)
	:: <code><{{var\|~~sectionName~~}}></code> – returns the ~~length~~ of the ~~given~~ section		*: <code><{{var\|section name}}></code> – returns the size of the named section
	:: <code>_lead</code> – returns the ~~length~~ of the lead section ~~(this~~ is ~~the~~ ~~default,~~ if ~~param~~ 2 is ~~absent)~~		*: <code>_lead</code> – returns the size of the lead section; default when second positional parameter is empty or omitted
	:: <code>_max</code> – returns the ~~length~~ of the longest section		*: <code>_max</code> – returns the size of the longest individual section
	:: <code>_total</code> – returns the ~~length~~ of the article (should = ~~{{tl~~\|PAGESIZE}} )		*: <code>_total</code> – returns the size of the article (should equal [[Help:Magic_words#Metadata\|PAGESIZE]])
	:<code>~~<{{var\|scope}}>~~</code> (optional) – the third positional parameter is the scope of the ~~length~~ measure; ~~if the value~~ <code>~~_all~~</code> is ~~passed,~~ ~~all~~ ~~subsections~~ of the section ~~whose name is given in parameter 2 are included in~~ the ~~length~~ ~~(optional;~~ ~~default:~~ subsections ~~excluded)~~		*<code>_all</code> (optional) – the third positional parameter is the scope of the size measure; requires <code><{{var\|section name}}></code>; not supported for keywords; returns size of the named section plus the sizes of its subsections

	~~'''~~Named parameters~~'''~~		====Named parameters====
	: <code>_nosep=yes</code> (optional) – if present, length is emitted without a thousands separator (default: with separator)
			*{{para\|_nosep}} (optional) – no separator; accepts one value: <code>yes</code>; section size emitted without thousands separators; ignored when {{para\|_pct}} is set (default: with separator)
	: <code>_pct=yes</code> (optional) – if present, length is emitted as a percentage of page length, rounded to 2 decimals, with a % symbol appended (default: length is given in bytes)
			*{{para\|_pct}} (optional) – percent; accepts one value: <code>yes</code>; emits size of <code><{{var\|section name}}></code>, <code>_lead</code>, <code>_max</code>, or <code>_total</code> as a percentage of <code>_total</code> rounded to 2 decimals with a '%' symbol

			==== Examples ====
			These examples refer to the same article as shown in the <code>size</code> example.

			Sizes of a named section with and without its subsections (<code>_all</code>):
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| Phonology }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| Phonology }}
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| Phonology \| _all }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| Phonology \| _all }}

			Keywords:
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| _lead }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| _lead }}
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| _max }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| _max }}
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| _total }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| _total }}

			Section sizes without thousands separator:
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| Phonology \| _nosep=yes }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| Phonology \| _nosep=yes }}
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| _total \| _nosep=yes }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| _total \| _nosep=yes }}

			Section sizes as a percentage of <code>_total</code>:
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| Phonology \| _pct=yes }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| Phonology \| _pct=yes }}
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| _lead \| _pct=yes }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| _lead \| _pct=yes }}
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| _max \| _pct=yes }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| _max \| _pct=yes }}
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| _total \| _pct=yes }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| _total \| _pct=yes }}

	== See also ==		== See also ==

Trappist the monk: /* size */ +example;

2024-09-22T19:54:55Z

size: +example;

← Previous revision		Revision as of 19:54, 22 September 2024
Line 12:		Line 12:
	*{{para\|style}} (optional) – css string suitable for use in the wikitable's <code>style=</code> attribute; for example to render the table at the right side of the page:		*{{para\|style}} (optional) – css string suitable for use in the wikitable's <code>style=</code> attribute; for example to render the table at the right side of the page:
	*:<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}\|size\|<{{var\|page name}}>\|style=float:right; margin-left:.5em}}</code>		*:<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}\|size\|<{{var\|page name}}>\|style=float:right; margin-left:.5em}}</code>
			====Example====
			<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|size\|Klingon language}}</syntaxhighlight>
			{{section sizes\|Klingon language}}

	=== <code>section_length_get</code> ===		=== <code>section_length_get</code> ===

Trappist the monk: /* size */ ce;

2024-09-22T11:52:36Z

size: ce;

← Previous revision		Revision as of 11:52, 22 September 2024
Line 5:		Line 5:

	=== <code>size</code> ===		=== <code>size</code> ===
	: Use entry point <code>size</code> to emit the section ~~table~~:		Use entry point <code>size</code> to emit the section wikitable:
	<code>{{((}}#invoke:{{BASEPAGENAME}}\|size\|<{{var\|page name}}>\|style=<{{var\|style string}}>}}</code>{{br}}		:<code>{{((}}#invoke:{{BASEPAGENAME}}\|size\|<{{var\|page name}}>\|style=<{{var\|style string}}>}}</code>{{br}}

	Entry point <code>size()</code> takes two arguments from <code>frame</code>, one positional and one named:		Entry point <code>size()</code> takes two arguments from <code>frame</code>, one positional and one named:
	:<code><{{var\|page name}}></code> (required) – the first positional parameter is the page name; may include namespace		*<code><{{var\|page name}}></code> (required) – the first positional parameter is the page name; may include namespace
	:{{para\|style}} (optional) – css string suitable for use in the ~~table~~'s <code>style=</code> attribute; for example to render the table at the right side of the page:		*{{para\|style}} (optional) – css string suitable for use in the wikitable's <code>style=</code> attribute; for example to render the table at the right side of the page:
	::<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}\|size\|<{{var\|page name}}>\|style=float:right; margin-left:.5em}}</code>		*:<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}\|size\|<{{var\|page name}}>\|style=float:right; margin-left:.5em}}</code>

	=== <code>section_length_get</code> ===		=== <code>section_length_get</code> ===

Mathglot: /* size */ Positional and named

2024-09-22T06:09:02Z

size: Positional and named

← Previous revision		Revision as of 06:09, 22 September 2024
Line 8:		Line 8:
	<code>{{((}}#invoke:{{BASEPAGENAME}}\|size\|<{{var\|page name}}>\|style=<{{var\|style string}}>}}</code>{{br}}		<code>{{((}}#invoke:{{BASEPAGENAME}}\|size\|<{{var\|page name}}>\|style=<{{var\|style string}}>}}</code>{{br}}

	Entry point <code>size()</code> takes two arguments from <code>frame</code>:		Entry point <code>size()</code> takes two arguments from <code>frame</code>, one positional and one named:
	:<code><{{var\|page name}}></code> (required) – the first positional parameter is the page name; may include namespace		:<code><{{var\|page name}}></code> (required) – the first positional parameter is the page name; may include namespace
	:{{para\|style}} (optional) – css string suitable for use in the table's <code>style=</code> attribute; for example to render the table at the right side of the page:		:{{para\|style}} (optional) – css string suitable for use in the table's <code>style=</code> attribute; for example to render the table at the right side of the page:

Mathglot: /* section_length_get */ Add additional invocation usage string.

2024-09-22T06:07:31Z

section_length_get: Add additional invocation usage string.

← Previous revision		Revision as of 06:07, 22 September 2024
Line 18:		Line 18:
	<code>{{((}}#invoke:{{BASEPAGENAME}}\|section_length_get\|<{{var\|page name}}>\|<{{var\|section name}}>}}</code>{{br}}		<code>{{((}}#invoke:{{BASEPAGENAME}}\|section_length_get\|<{{var\|page name}}>\|<{{var\|section name}}>}}</code>{{br}}
	<code>{{((}}#invoke:{{BASEPAGENAME}}\|section_length_get\|<{{var\|page name}}>\|<{{var\|section name}}> \|_all}}</code>{{br}}		<code>{{((}}#invoke:{{BASEPAGENAME}}\|section_length_get\|<{{var\|page name}}>\|<{{var\|section name}}> \|_all}}</code>{{br}}
			<code>{{((}}#invoke:{{BASEPAGENAME}}\|section_length_get\|<{{var\|page name}}>\|<{{var\|section name}}> \|_all \|_pct=yes \|_nosep=yes}}</code>{{br}}
	<code>{{((}}#invoke:{{BASEPAGENAME}}\|section_length_get\|<{{var\|page name}}>\|<{{var\|token}}>}}</code>{{br}}		<code>{{((}}#invoke:{{BASEPAGENAME}}\|section_length_get\|<{{var\|page name}}>\|<{{var\|token}}>}}</code>{{br}}

Line 28:		Line 29:
	:: <code>_total</code> – returns the length of the article (should = {{tl\|PAGESIZE}} )		:: <code>_total</code> – returns the length of the article (should = {{tl\|PAGESIZE}} )
	:<code><{{var\|scope}}></code> (optional) – the third positional parameter is the scope of the length measure; if the value <code>_all</code> is passed, all subsections of the section whose name is given in parameter 2 are included in the length (optional; default: subsections excluded)		:<code><{{var\|scope}}></code> (optional) – the third positional parameter is the scope of the length measure; if the value <code>_all</code> is passed, all subsections of the section whose name is given in parameter 2 are included in the length (optional; default: subsections excluded)
			'''Named parameters'''
	: <code>_nosep=yes</code> (optional) – if present, length is emitted without a thousands separator (default: with separator)		: <code>_nosep=yes</code> (optional) – if present, length is emitted without a thousands separator (default: with separator)
	: <code>_pct=yes</code> (optional) – if present, length is emitted in ~~percent~~ of page length, rounded to 2 decimals, with a % symbol appended (default: length is given in bytes)		: <code>_pct=yes</code> (optional) – if present, length is emitted as a percentage of page length, rounded to 2 decimals, with a % symbol appended (default: length is given in bytes)

	== See also ==		== See also ==

Mathglot: /* Usage */ Add _nosep and _pct, and redo positional param 3 as scoping arg.

2024-09-22T06:04:03Z

Usage: Add _nosep and _pct, and redo positional param 3 as scoping arg.

← Previous revision		Revision as of 06:04, 22 September 2024
Line 4:		Line 4:
	This module has two entry points: <code>size</code>, and <code>section_length_get</code>.		This module has two entry points: <code>size</code>, and <code>section_length_get</code>.

	~~: Use~~ <code>size</code> ~~to emit the section table:~~		=== <code>size</code> ===
			: Use entry point <code>size</code> to emit the section table:
	<code>{{((}}#invoke:{{BASEPAGENAME}}\|size\|<{{var\|page name}}>\|style=<{{var\|style string}}>}}</code>{{br}}		<code>{{((}}#invoke:{{BASEPAGENAME}}\|size\|<{{var\|page name}}>\|style=<{{var\|style string}}>}}</code>{{br}}

Line 11:		Line 12:
	:{{para\|style}} (optional) – css string suitable for use in the table's <code>style=</code> attribute; for example to render the table at the right side of the page:		:{{para\|style}} (optional) – css string suitable for use in the table's <code>style=</code> attribute; for example to render the table at the right side of the page:
	::<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}\|size\|<{{var\|page name}}>\|style=float:right; margin-left:.5em}}</code>		::<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}\|size\|<{{var\|page name}}>\|style=float:right; margin-left:.5em}}</code>

			=== <code>section_length_get</code> ===

	: Use entry point <code>section_length_get</code> to return an article or section length statistic:		: Use entry point <code>section_length_get</code> to return an article or section length statistic:
Line 17:		Line 20:
	<code>{{((}}#invoke:{{BASEPAGENAME}}\|section_length_get\|<{{var\|page name}}>\|<{{var\|token}}>}}</code>{{br}}		<code>{{((}}#invoke:{{BASEPAGENAME}}\|section_length_get\|<{{var\|page name}}>\|<{{var\|token}}>}}</code>{{br}}

	Entry point <code>section_length_get()</code> takes one, ~~two, or~~ three arguments from <code>frame</code>:		Entry point <code>section_length_get()</code> takes one to three positional arguments from <code>frame</code>, and two named arguments:
	:<code><{{var\|page name}}></code> (required) – the first positional parameter is the page name; may include namespace		:<code><{{var\|page name}}></code> (required) – the first positional parameter is the page name; may include namespace
	:<code><{{var\|section name}}></code> (optional) – the second positional parameter is either the section name, or one of three tokens (if param 2 is absent, the default is _lead)		:<code><{{var\|section name}}></code> (optional) – the second positional parameter is either the section name, or one of three tokens (if param 2 is absent, the default is _lead)
Line 24:		Line 27:
	:: <code>_max</code> – returns the length of the longest section		:: <code>_max</code> – returns the length of the longest section
	:: <code>_total</code> – returns the length of the article (should = {{tl\|PAGESIZE}} )		:: <code>_total</code> – returns the length of the article (should = {{tl\|PAGESIZE}} )
	:<code>~~_all~~</code> (optional) – the third positional parameter is the ~~string~~ <code>_all</code>; ~~this~~ ~~includes~~ ~~the~~ ~~total length~~ of the section whose name is given in parameter 2, ~~including~~ ~~all~~ ~~its~~ subsections.		:<code><{{var\|scope}}></code> (optional) – the third positional parameter is the scope of the length measure; if the value <code>_all</code> is passed, all subsections of the section whose name is given in parameter 2 are included in the length (optional; default: subsections excluded)
			: <code>_nosep=yes</code> (optional) – if present, length is emitted without a thousands separator (default: with separator)
			: <code>_pct=yes</code> (optional) – if present, length is emitted in percent of page length, rounded to 2 decimals, with a % symbol appended (default: length is given in bytes)

	== See also ==		== See also ==

Mathglot: Add second entry point section_length_get; add usage examples and param descriptions.

2024-09-22T01:18:14Z

Add second entry point section_length_get; add usage examples and param descriptions.

← Previous revision		Revision as of 01:18, 22 September 2024
Line 2:		Line 2:

	== Usage ==		== Usage ==
	This module has ~~a single~~ entry ~~point~~:		This module has two entry points: <code>size</code>, and <code>section_length_get</code>.
⚫	<code~~><nowiki~~>{{~~</nowiki>~~#invoke:{{BASEPAGENAME}}\|size\|<{{var\|page name}}>\|style=<{{var\|style string}}>}}</code>

	<code>size()</code> ~~takes~~ ~~two~~ ~~arguments~~ ~~from~~ ~~<code>frame</code>~~:		: Use <code>size</code> to emit the section table:
		⚫	<code>{{((}}#invoke:{{BASEPAGENAME}}\|size\|<{{var\|page name}}>\|style=<{{var\|style string}}>}}</code>{{br}}

			Entry point <code>size()</code> takes two arguments from <code>frame</code>:
	:<code><{{var\|page name}}></code> (required) – the first positional parameter is the page name; may include namespace		:<code><{{var\|page name}}></code> (required) – the first positional parameter is the page name; may include namespace
	:{{para\|style}} (optional) – css string suitable for use in the table's <code>style=</code> attribute; for example to render the table at the right side of the page:		:{{para\|style}} (optional) – css string suitable for use in the table's <code>style=</code> attribute; for example to render the table at the right side of the page:
	::<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}\|size\|<{{var\|page name}}>\|style=float:right; margin-left:.5em}}</code>		::<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}\|size\|<{{var\|page name}}>\|style=float:right; margin-left:.5em}}</code>

			: Use entry point <code>section_length_get</code> to return an article or section length statistic:
			<code>{{((}}#invoke:{{BASEPAGENAME}}\|section_length_get\|<{{var\|page name}}>\|<{{var\|section name}}>}}</code>{{br}}
			<code>{{((}}#invoke:{{BASEPAGENAME}}\|section_length_get\|<{{var\|page name}}>\|<{{var\|section name}}> \|_all}}</code>{{br}}
			<code>{{((}}#invoke:{{BASEPAGENAME}}\|section_length_get\|<{{var\|page name}}>\|<{{var\|token}}>}}</code>{{br}}

			Entry point <code>section_length_get()</code> takes one, two, or three arguments from <code>frame</code>:
			:<code><{{var\|page name}}></code> (required) – the first positional parameter is the page name; may include namespace
			:<code><{{var\|section name}}></code> (optional) – the second positional parameter is either the section name, or one of three tokens (if param 2 is absent, the default is _lead)
			:: <code><{{var\|sectionName}}></code> – returns the length of the given section
			:: <code>_lead</code> – returns the length of the lead section (this is the default, if param 2 is absent)
			:: <code>_max</code> – returns the length of the longest section
			:: <code>_total</code> – returns the length of the article (should = {{tl\|PAGESIZE}} )
			:<code>_all</code> (optional) – the third positional parameter is the string <code>_all</code>; this includes the total length of the section whose name is given in parameter 2, including all its subsections.

	== See also ==		== See also ==

Mathglot: /* See also */ Add Template:Section length.

2024-09-20T06:47:25Z

JPxG at 23:15, 1 May 2023

2023-05-01T23:15:22Z

← Previous revision		Revision as of 23:15, 1 May 2023
Line 1:		Line 1:
	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; ~~largest~~ section's ~~byte-count~~ is ~~highlighted~~ in red.		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 ==		== Usage ==

← Previous revision		Revision as of 19:58, 22 September 2024
Line 16:		Line 16:
	{{section sizes\|Klingon language}}		{{section sizes\|Klingon language}}

	=== <code>~~section_length_get~~</code> ===		=== <code>section_size_get</code> ===

	~~: Use entry point~~ <code>~~section_length_get~~</code> to return an article or section ~~length~~ statistic:		<code>section_size_get</code> return an article or section size statistic:
	<code>{{((}}#invoke:{{BASEPAGENAME}}\|~~section_length_get~~\|<{{var\|page name}}>\|<{{var\|section name}}>}}</code>~~{{br}}~~		:<code>{{((}}#invoke:{{BASEPAGENAME}}\|section_size_get\|<{{var\|page name}}>\|[<{{var\|section name}}{{!}}{{var\|token}}>]\|_all\|_pct=yes \|_nosep=yes}}</code>
	<code>{{((}}#invoke:{{BASEPAGENAME}}\|section_length_get\|<{{var\|page name}}>\|<{{var\|section name}}> \|_all}}</code>{{br}}
	<code>{{((}}#invoke:{{BASEPAGENAME}}\|section_length_get\|<{{var\|page name}}>\|<{{var\|section name}}> \|_all \|_pct=yes \|_nosep=yes}}</code>{{br}}
	<code>{{((}}#invoke:{{BASEPAGENAME}}\|section_length_get\|<{{var\|page name}}>\|<{{var\|token}}>}}</code>{{br}}

	~~Entry point~~ <code>~~section_length_get()~~</code> takes one to three positional ~~arguments~~ from <code>frame</code>~~, and two named arguments~~:		<code>section_size_get</code> takes one to three positional parameters and two named parameters from <code>frame</code>:
	:<code><{{var\|page name}}></code> (required) – the first positional parameter is the page name; may include namespace		*<code><{{var\|page name}}></code> (required) – the first positional parameter is the page name; may include namespace
	:<code><{{var\|section name}}></code> (optional) – the second positional parameter is either the section name, or one of three tokens (if param 2 is absent, the default is ~~_lead~~)		*<code><{{var\|section name}}{{!}}{{var\|token}}></code> (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)
	:: <code><{{var\|~~sectionName~~}}></code> – returns the ~~length~~ of the ~~given~~ section		*: <code><{{var\|section name}}></code> – returns the size of the named section
	:: <code>_lead</code> – returns the ~~length~~ of the lead section ~~(this~~ is ~~the~~ ~~default,~~ if ~~param~~ 2 is ~~absent)~~		*: <code>_lead</code> – returns the size of the lead section; default when second positional parameter is empty or omitted
	:: <code>_max</code> – returns the ~~length~~ of the longest section		*: <code>_max</code> – returns the size of the longest individual section
	:: <code>_total</code> – returns the ~~length~~ of the article (should = ~~{{tl~~\|PAGESIZE}} )		*: <code>_total</code> – returns the size of the article (should equal [[Help:Magic_words#Metadata\|PAGESIZE]])
	:<code>~~<{{var\|scope}}>~~</code> (optional) – the third positional parameter is the scope of the ~~length~~ measure; ~~if the value~~ <code>~~_all~~</code> is ~~passed,~~ ~~all~~ ~~subsections~~ of the section ~~whose name is given in parameter 2 are included in~~ the ~~length~~ ~~(optional;~~ ~~default:~~ subsections ~~excluded)~~		*<code>_all</code> (optional) – the third positional parameter is the scope of the size measure; requires <code><{{var\|section name}}></code>; not supported for keywords; returns size of the named section plus the sizes of its subsections

	~~'''~~Named parameters~~'''~~		====Named parameters====
	: <code>_nosep=yes</code> (optional) – if present, length is emitted without a thousands separator (default: with separator)
			*{{para\|_nosep}} (optional) – no separator; accepts one value: <code>yes</code>; section size emitted without thousands separators; ignored when {{para\|_pct}} is set (default: with separator)
	: <code>_pct=yes</code> (optional) – if present, length is emitted as a percentage of page length, rounded to 2 decimals, with a % symbol appended (default: length is given in bytes)
			*{{para\|_pct}} (optional) – percent; accepts one value: <code>yes</code>; emits size of <code><{{var\|section name}}></code>, <code>_lead</code>, <code>_max</code>, or <code>_total</code> as a percentage of <code>_total</code> rounded to 2 decimals with a '%' symbol

			==== Examples ====
			These examples refer to the same article as shown in the <code>size</code> example.

			Sizes of a named section with and without its subsections (<code>_all</code>):
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| Phonology }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| Phonology }}
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| Phonology \| _all }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| Phonology \| _all }}

			Keywords:
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| _lead }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| _lead }}
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| _max }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| _max }}
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| _total }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| _total }}

			Section sizes without thousands separator:
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| Phonology \| _nosep=yes }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| Phonology \| _nosep=yes }}
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| _total \| _nosep=yes }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| _total \| _nosep=yes }}

			Section sizes as a percentage of <code>_total</code>:
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| Phonology \| _pct=yes }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| Phonology \| _pct=yes }}
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| _lead \| _pct=yes }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| _lead \| _pct=yes }}
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| _max \| _pct=yes }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| _max \| _pct=yes }}
			*<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Section sizes\|section_size_get\| Klingon language \| _total \| _pct=yes }}</syntaxhighlight> → {{#invoke:Section sizes\|section_size_get\| Klingon language \| _total \| _pct=yes }}

	== See also ==		== See also ==

← Previous revision		Revision as of 06:47, 20 September 2024
Line 12:		Line 12:
	== See also ==		== See also ==
	* [[Template:Section sizes]], a pre-styled template for talk pages which invokes this module		* [[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

	<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox \| \|		<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox \| \|