View source for Template:WikiProject banner shell/doc

{{Template shortcut|WPB|WPBS|Bannershell|WikiProject Shell}}
{{Uses TemplateStyles|Template:WikiProject banner shell/styles.css}}
{{Documentation subpage}}
{{High-use}}
{{AWB standard installation}}
{{Bot use warning|bots=[[Wikipedia:Bots/Requests for approval/Cewbot 3|cewbot]]}}<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->

== Usage ==
This template combines talk page banners into a nested shell and/or displays a general quality assessment for an article. It was designed for [[Wikipedia:Template index/WikiProject banners|WikiProject banners]] and will only work reliably with such templates. WikiProject banner shell 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 like 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.

=== Syntax ===
The {{Para|1}} parameter is not optional and must be included at the end of the first line.

==== Basic ====
<pre style="border-width: 3px; margin-left: 2.5vw; width: 24em;"><nowiki>{{WikiProject banner shell|class=|1=
{{FirstProjectBanner}}
{{SecondProjectBanner}}
{{ThirdProjectBanner}}
…
}}</nowiki></pre>

==== Full ====
<pre style="border-width: 3px; margin-left: 2.5vw; width: 48em;"><nowiki>{{WikiProject banner shell|class=|blp=|blpo=|activepol=|collapsed=|1=
{{FirstProjectBanner}}
{{SecondProjectBanner}}
{{ThirdProjectBanner}}
…
|header=
}}</nowiki></pre>

=== Optional parameters ===
# Adding a quality rating after {{para|class}} will cause the banner shell to display the quality rating for the article (e.g. Start, C, GA etc.) based on [[Wikipedia:Content assessment]]. This value will be available to the project banner templates, which may use it in forming categories like <code>Category:Start-class Ruritania articles.</code>
# Adding {{Para|blp|yes}} or its alias {{Para|living|yes}} will display the {{Template link general|BLP|brace=yes|nowrap=yes|plaincode=yes}} banner above the shell, detailing Wikipedia's official policies regarding [[Wikipedia:Biographies of living persons|biographies of living persons]].  This '''must''' be added for articles about living people.
# Adding {{Para|blpo|yes}} will display the {{Template link general|BLP others|brace=yes|nowrap=yes|plaincode=yes}} banner above the shell.  This should be used for articles where {{Template link general|BLP|nolink=yes|plaincode=yes}} does not apply directly to the subject, but which nevertheless have content that directly relates to other living persons. It is mutually-exclusive with {{Para|blp|yes}}.
# Adding {{Para|activepol|yes}} will display the {{Template link general|Active politician|brace=yes|nowrap=yes|plaincode=yes}} banner above the shell.
# Adding {{Para|collapsed|yes}} will cause the outer table to be collapsed, hiding even the project names. Explicitly adding {{Para|collapsed|no}} (the default) will cause the outer table to not be collapsed, showing the summary of the banners, and prevent any bots that might have logic that would cause them to assign a value of {{Var|yes}} from doing so.
# Adding {{Para|header|{{Var|Custom header text}}}} allows for the replacement of the default table title text ("This <nowiki>{{PAGETYPE}}</nowiki> is of interest to the following WikiProjects:") with whatever is supplied as its value.

=== 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. ({{Compare pages|999121685|Wikipedia talk:WikiProject Food and drink#Template:WikiProject Food and drink cannot be used inside Template:WikiProject banner shell with some parameters|Example report}}) –[[User:davidwr|davidwr]] <span style="font-size: x-small; vertical-align: super;">([[User_talk:davidwr|talk]]/[[Special:Contributions/Davidwr|contribs]])</span> 16:24, 8 January 2021 (UTC)

== TemplateData ==
{{Collapse top|TemplateData used by [[mw:Extension:TemplateWizard|TemplateWizard]], [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{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": [
		"collapsed",
		"living",
		"blpo",
		"activepol",
		"header",
		"1"
	],
	"params": {
		"1": {
			"label": "WikiProject banners",
			"description": "Place the individual project banners here, one per line",
			"type": "content",
			"required": true
		},
		"living": {
			"aliases": [
				"blp"
			],
			"label": "Living subject",
			"description": "Triggers the display of more verbose warnings about the extra editing constraints on these articles when set to: ['yes']",
			"example": "yes",
			"type": "boolean",
			"default": "no"
		},
		"blpo": {
			"label": "Deceased subject with living family",
			"description": "This triggers a warning to appear above the shell reminding editors that extra restraints remain in effect for details about living family of deceased persons when set to: ['yes']",
			"example": "yes",
			"type": "boolean",
			"default": "no"
		},
		"activepol": {
			"label": "Active politician",
			"description": "Causes the active politician notice to appear above the shell, with warnings about extra editing restrictions, when set to: ['yes']",
			"example": "yes",
			"type": "boolean",
			"default": "no"
		},
		"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 one of: ['yes', 'no']",
			"example": "yes",
			"type": "boolean",
			"default": "no"
		},
		"header": {
			"label": "Custom header text",
			"description": "Replaces the default preamble (&quot;This &lbrace;&lbrace;PAGETYPE&rbrace;&rbrace; is of interest to the following WikiProjects:&quot;) with the value given here",
			"type": "content"
		}
	}
}</templatedata>}}
{{Collapse bottom}}

== See also ==
* {{Template link general|Skip to talk|brace=yes}} – To skip past the many banners and templates straight to the table of contents
* {{Template link general|Talk header|brace=yes}} – Used at the top of some pages
* {{Template link general|WPBannerMeta|brace=yes}} – The skeleton template for individual WikiProject banners

=== Other shell templates ===
* {{Template link general|Article history|brace=yes}} – For a template to condense Peer Reviews and other Good- or Featured-article history
* {{Template link general|Banner holder|brace=yes}}
* {{Template link general|Old XfD multi|brace=yes}} – For listing multiple deletion debates
* {{Template link general|Redirect category shell|brace=yes}} – 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:WikiProject banner templates]]
}}