View source for Template:WikiProject banner shell/doc

{{Documentation subpage}}
{{Redirect|Template:WikiProject banner|the code that is used to build all the WikiProject banners|Module:WikiProject banner}}
{{High-use}}
{{Template shortcut|WPBS}}
{{Banner shell related}}
{{Lua|Module:Banner shell}}
{{AWB standard installation}}
{{Bot use warning|bots=[[User:Cewbot/log/20200122/configuration|cewbot]]}}

== Usage ==
This template combines talk page banners into a nested shell and displays a general quality assessment for an article. It was designed for [[Wikipedia:Template index/WikiProject banners|WikiProject banners]] and will work reliably only with such templates. This template may be added to an article talk page with no WikiProject banners, but with a {{para|class}} quality assessment value, in which case it will populate a general category such as [[:Category:C-Class articles]].

WikiProject assessment bots may change shell templates per this usage guideline ''when the bot is editing the talk page for other reasons''. If local consensus on a talk page is to not follow this guideline, please specify {{Para|collapsed|yes}} or {{Para|collapsed|no}} explicitly to override the bots.

=== Basic ===
<syntaxhighlight lang="wikitext" style="border-width: 3px; margin-left: 2.5vw; width: 24em;">
{{WikiProject banner shell|class=|
{{First Project Banner}}
{{Second Project Banner}}
{{Third Project Banner}}
...
}}</syntaxhighlight>

=== Full ===
<syntaxhighlight lang="wikitext" style="border-width: 3px; margin-left: 2.5vw; width: 54em;">
{{WikiProject banner shell|class=|vital=|blp=|collapsed=|listas=|
{{First Project Banner}}
{{Second Project Banner}}
{{Third Project Banner}}
...
}}</syntaxhighlight>

== Project-independent quality assessments ==
{{shortcut|WP:PIQA}}
In February 2023, the [[Wikipedia:Village pump (proposals)/Archive 198#Project-independent quality assessments|Wikipedia community expressed strong support]] for article [[Wikipedia:Content assessment|quality assessments]] that are independent of WikiProjects.

Consensus was found for adding a {{para|class}} parameter to [[Template:WikiProject banner shell]], which all projects would inherit. To avoid redundancy, this rating is then shown only on the banner shell. Projects can choose to opt-out of this system by adding the parameter {{para|QUALITY_CRITERIA|custom}} to their project banner template.

It is also possible to add a standalone banner shell template to an article without any WikiProjects, for example <syntaxhighlight lang="wikitext" inline>{{WikiProject banner shell|class=start}}</syntaxhighlight>.

[[User:Cewbot/log/20200122/configuration|Cewbot]] will regularly maintain <syntaxhighlight lang="wikitext" inline>{{WikiProject banner shell}}</syntaxhighlight>.

== Parameters ==
All parameters are optional.
{{Format TemplateData|1=<templatedata>{
	"description": "Aggregates and compresses the display of multiple, vertically-stacked WikiProject banner templates on pages in odd-numbered namespaces into a more information dense layout",
	"format": "inline",
	"paramOrder": [
		"class",
		"blp",
		"collapsed",
		"listas",
		"1",
		"vital"
	],
	"params": {
		"1": {
			"label": "WikiProject banners",
			"description": "Place the individual project banners here, one per line",
			"type": "content",
			"required": false
		},
		"class": {
			"label": "class",
			"description": "Display the standard quality assessment rating, e.g. Start, C, GA",
			"type": "string",
			"required": false,
			"example": "Start",
			"suggestedvalues": [
				"FA",
				"FL",
				"A",
				"GA",
				"B",
				"C",
				"Start",
				"Stub",
				"List",
				"FM"
			],
			"suggested": true
		},
		"blp": {
			"label": "Living subject",
			"description": "Triggers the display of more verbose warnings about the extra editing constraints on these articles.<br />Use \"yes\" for a living person.<br />Use \"no\" for a dead person.<br />Use \"other\" if the subject of the article is not a living person, but the article contains sensitive information about other living persons.<br />Use \"activepol\" if the article is about a currently active politician. <br />Leave the field blank if the subject of the article does not involve a person.",
			"example": "yes",
			"type": "string",
			"suggestedvalues": [
				"activepol",
				"yes",
				"other",
				"no"
			],
			"suggested": true
		},
		"collapsed": {
			"label": "Collapse project banners",
			"description": "Load template in its collapsed state, hiding even the name, class and importance values for the individual WikiProjects contained within; set to 'yes' if desired.",
			"example": "yes",
			"type": "boolean",
			"default": "no (collapsed=no is deprecated, do not use)"
		},
		"listas": {
			"label": "Sort key",
			"description": "Sets the default sort key for the current page",
			"example": "Smith, John",
			"type": "string"
		},
		"vital": {
			"description": "If set to yes, then the module will check subpages of [[Wikipedia:Vital articles/data]] to see if the article is a vital article. If so, then it will display a message and link to the relevant sublist of vital articles.",
			"type": "boolean"
		}
	}
}</templatedata>}}

== Limitations and bugs ==
[[:Category:Pages where expansion depth is exceeded|Pages where expansion depth is exceeded]] issue: This "shell template" adds to the "expansion depth" of the page. In certain circumstances, it can cause the page to exceed the limit. If this happens, find out which enclosed template is already "near the limit" and notify the WikiProject responsible for that template that there is an issue. Include details, as some WikiProject templates only get "close to the limit" with uncommon combinations of parameters. ([[Special:Permalink/999121685#Template:WikiProject Food and drink cannot be used inside Template:WikiProject banner shell with some parameters|Example report]])

== Tracking categories ==
{{columns-start}}
* {{Category link with count|Pages using WikiProject banner shell with duplicate banner templates}}
* {{Category link with count|Pages using WikiProject banner shell with unknown parameters}}
* {{Category link with count|WikiProject banners placed outside the banner shell}}
* {{Category link with count|WikiProjects using a non-standard quality scale}}
* {{Category link with count|Wikipedia vital articles needing attention|pages}}
{{column}}
* {{Category link with count|B-Class articles with conflicting quality ratings}}
* {{Category link with count|C-Class articles with conflicting quality ratings}}
* {{Category link with count|Start-Class articles with conflicting quality ratings}}
* {{Category link with count|Stub-Class articles with conflicting quality ratings}}
* {{Category link with count|List-Class articles with conflicting quality ratings}}
{{columns-end}}

=== Category renaming ===
* {{Category link with count|Wikipedia non-empty soft redirected categories}} - Contains items from the recent name changes of categories ending in '''''articles''''' to '''''pages'''''.

== See also ==
* {{Template link general|Skip to talk}} – To skip past the many banners and templates straight to the table of contents
* {{Template link general|Talk header}} – Used at the top of some pages
* [[Module:WikiProject banner]] – the meta module for individual WikiProject banners
* [[:Category:Pages using WikiProject banner shell needing attention]]

=== Other shell templates ===
* {{Template link general|Article history}} – For a template to condense Peer Reviews and other Good- or Featured-article history
* {{Template link general|Banner holder}}
* {{Template link general|Old XfD multi}} – For listing multiple deletion debates
* {{Template link general|Redirect category shell}} – For listing one or more [[Wikipedia:Template index/Redirect pages#Alphanumeric listing|redirect category templates]]

{{Sandbox other||<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Non-subject-matter-related article-talk header templates]]
[[Category:Template shell templates]]
[[Category:Templates that are not mobile friendly]]
[[Category:Pages related to the WikiProject meta banner|Shell]]
}}