View source for Template:Section sizes/doc

{{Documentation subpage}}
{{Lua|Module:Section sizes}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
To be used on the talk pages of very long articles, or in discussion of other articles where it is desired to show the sizes of subsections. The largest byte count and cumulative section total are coloured in red; the larger a section is, the redder it's shaded.

== Usage ==

Use:

:<code><nowiki>{{Section sizes}}</nowiki></code> 

or include the name of a page as the first (and only) parameter, as one of:

:<code><nowiki>{{Section sizes|1919 New Year Honours}}</nowiki></code>

:<code><nowiki>{{Section sizes|1=1919 New Year Honours}}</nowiki></code>

or include a [[CSS]] style string:

:<code><nowiki>{{Section sizes|1919 New Year Honours|style=float:right; margin-left:.5em}}</nowiki></code>

== Example ==

{{demo|<nowiki>{{Section sizes|1919 New Year Honours}}</nowiki>}}

== Messaging ==

There are three fatal errors and one advisory message which may be reported by the template.

'''Fatal errors:'''
* <span style="color:#d73333">error: no article: &lt;{{var|article title}}></span> – emitted when the template cannot fetch the content of &lt;{{var|article title}}>
* <span style="color:#d73333">error: &lt;{{var|article title}}> is a redirect</span> – emitted when &lt;{{var|article title}}> is a redirect
* <span style="color:#d73333">error: no sections found in: &lt;{{var|article title}}></span> – emitted when &lt;{{var|article title}}> does not have any sections except the lede

'''Advisory message:'''
* <span style="color:#d33">markup removed; cannot link</span> – this is emitted when a section header of the article contains [[MOS:NOSECTIONLINKS|invalid markup such as an embedded citation]]; in this case, the section header is emitted in plain text as it cannot be linked for technical reasons. The gory details follow.

The template attempts to correctly render and link section names.  That is not always possible because of Html and [[wikicode|wiki markup]] that should not be in the section name; see [[MOS:HEAD]].  The template attempts to render a readable, but unlinked section name with a message and link to this page when Html and wiki markup is found. For these cases, the page that transcludes this template will be added to a tracking category. 

The template retains bold (<code><nowiki>'''</nowiki></code>) and italic (<code><nowiki>''</nowiki></code>) wiki markup and will leave any self-closed {{tag|nowiki|s}} tags.  When templates are present, this template renders them and then removes any Html and Html-like markup.  Wikilinks in the section name are replaced with their display text.

== Categorization ==

When an unlinked section name is emitted in the table along with a "markup removed" error (see {{slink||Messaging}}) because of parsing issues in the section header, the page on which the template appears is tracked in [[:Category:Pages with Template:Section sizes errors]].

== TemplateData ==
{{TemplateData header}}

<templatedata>
{
	"params": {
		"1": {
			"description": "Override the name of the page to use",
			"example": "1919 New Year Honours",
			"type": "wiki-page-name",
			"default": "{{ARTICLEPAGENAME}}"
		},
		"style": {
			"description": "CSS style",
			"example": "float:right; margin-left:.5em",
			"type": "string"
		}
	}
}</templatedata>

<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Data retrieval templates]]

}}</includeonly>