View source for Template:Section length/doc

{{Documentation subpage}}
{{tsh|Slen}}
{{lua|Module:Section sizes}}
{{template rating|alpha}}
Returns the length of a given section of a page, the size of the longest section, or the size of the article.
== Usage ==
{{tlc|section length | ''Article'' | ''Section''}}{{br}}
{{tlc|section length | ''Article'' | ''Section''|nosep{{=}}y}}{{br}}
{{tlc|section length | ''Article'' | ''Section''|pct{{=}}y}}{{br}}
{{tlc|section length | ''Article'' | ''token''}}{{br}}
{{tlc|section length | ''Article''}}

== Parameters ==
There is one required parameter, and four optional parameters:

* {{para|1}} – the name of the article or page (required)
* {{para|2}} – the section name, or a token with leading underscore (optional; if absent, {{pval|_lead}} is the default):
*:: {{para|2|''SectionName''}}  – returns the length of the given section 
*:: {{para|2|_lead}}  – returns the length of the lead section (default if param 2 is absent)
*:: {{para|2|_max}}  –  returns the length of the longest section
*:: {{para|2|_total}}  – returns the length of the article (should = {{tl|PAGESIZE}}{{hairspace}})
* {{para|3|_all}} – with param 2 set to a section name, add this to return section size including all its subsections (optional; default: return only the length before the first subsection heading)
* {{para|pct}} – set to any non-empty value, returns section length as percent of article length, rounded to 2 decimal places (optional)
* {{para|nosep}} – set to any non-empty value, returns byte length without thousand separators (optional; default: with separators)

== Examples ==

* {{tlx | section length | World War II  | Background |_show_result=1}} &nbsp; &nbsp; &nbsp;''– length in bytes of [[World War II#Background]]'' excluding subsections
* {{tlx | section length | World War II  | Background | _all |_show_result=1}} &nbsp; &nbsp; &nbsp;''– length of [[World War II#Background]]'' including all subsections
* {{tlx | section length | World War II  |_total |_show_result=1}} &nbsp; &nbsp; &nbsp;''– total length of [[World War II]]''
* {{tlx | section length | World War II  | nosep{{=}}y |_total |_show_result=1}} &nbsp; &nbsp; &nbsp;''– as above, without the comma''
* {{tlx | section length | World War II  |_lead |_show_result=1}} &nbsp; &nbsp; &nbsp;''– length in bytes of the lead''
* {{tlx | section length | World War II  |_lead |pct{{=}}y |_show_result=1}} &nbsp; &nbsp; &nbsp;''– length of the lead as a percent of article length''
* {{tlx | section length | World War II |pct{{=}}y |_show_result=1}} &nbsp; &nbsp; &nbsp;''– same as above; param 2 is optional''
* {{tlx | section length | World War II  |_max  |_show_result=1}} &nbsp; &nbsp; &nbsp;''– length in bytes of longest section''
* {{tlx | section length | France  |_total |_show_result=1}} &nbsp; &nbsp; &nbsp;''– total length in bytes of [[France]]''
* {{tlx | section length | France  |_lead |_show_result=1}} &nbsp; &nbsp; &nbsp;''– length of the lead section in bytes''
* {{tlx | section length | France  |_show_result=1}} &nbsp; &nbsp; &nbsp;''– same as above; param 2 is optional''
* {{tlx | section length | France |pct{{=}}y |_show_result=1}} &nbsp; &nbsp; &nbsp;''– length of the lead section as a percent of article length''
* {{tlx | section length | France    | Environment |_show_result=1}} &nbsp; &nbsp; &nbsp;''– length of [[France#Environment]]''
* {{tlx | section length | France    | Environment | nosep{{=}}y |_show_result=1}} &nbsp; &nbsp; &nbsp;''– same, without thousands separator''
* {{tlx | section length | France  | Environment |pct{{=}}y |_show_result=1}} &nbsp; &nbsp; &nbsp;''– length of section as a percent of article length''
* {{tlx | section length | France  | Whoopsie! |pct{{=}}y |_show_result=1}} &nbsp; &nbsp; &nbsp;''– when the section doesn't exist''
* {{tlx | section length | Franceee |pct{{=}}y |_show_result=1}} &nbsp; &nbsp; &nbsp;''– when the article doesn't exist''

== See also ==

* [[Module:Section sizes]]
* [[Template:Section sizes]]
<includeonly>{{Sandbox other||
<!-- Categories below this line -->
[[Category:Wikipedia formatting templates]]
}}</includeonly>