Template:WikiProject banner shell/doc

From the AARoads Wiki: Read about the road before you go
Jump to navigation Jump to search

Usage

This template combines talk page banners into a nested shell and displays a general quality assessment for an article. It was designed for 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 |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 |collapsed=yes or |collapsed=no explicitly to override the bots.

Basic

{{WikiProject banner shell|class=|
{{FirstProjectBanner}}
{{SecondProjectBanner}}
{{ThirdProjectBanner}}
...
}}

Full

{{WikiProject banner shell|class=|vital=|blp=|blpo=|activepol=|collapsed=|listas=|
{{FirstProjectBanner}}
{{SecondProjectBanner}}
{{ThirdProjectBanner}}
...
}}

Project-independent quality assessments

In February 2023, the Wikipedia community expressed strong support for article quality assessments that are independent of WikiProjects.

Consensus was found for adding a |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 |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 {{WikiProject banner shell | class=start}}

Cewbot will regularly maintain {{WikiProject banner shell}}.

Parameters

All parameters are optional.

Parameters for Template:WikiProject banner shell
Parameter Notes
class Adding a quality rating (e.g. Start, C, GA etc.) after |class= will cause the banner shell to display the quality rating for the article based on Wikipedia:Content assessment. This value will be available to the project banner templates, which may use it in forming categories like Category:Start-class Ruritania articles.
vital If |vital=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.
1 Holds a list of WikiProject banners, each with their parameters. It is not necessary to pass the |class= value to the banners, which will use the value supplied to this template if relevant.
blp |blp=yes or its alias |living=yes will display the {{BLP}} banner above the shell, detailing Wikipedia's official policies regarding biographies of living persons. Set to |blp=no for dead persons. This parameter must be added for biographical articles.
blpo |blpo=yes will display the {{BLP others}} banner above the shell. This should be used for articles where {{BLP}} does not apply directly to the subject, but which nevertheless have content that directly relates to other living persons. It is mutually-exclusive with |blp=yes.
activepol |activepol=yes will display the {{Active politician}} banner above the shell.
listas Sets the default sort key for the current page, e.g. |listas=Smith, John
collapsed |collapsed=yes will cause the outer table to be collapsed, hiding even the project names. Explicitly adding |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 yes from doing so.

Limitations and bugs

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. (Example report)

TemplateData

TemplateData used by TemplateWizard, VisualEditor and other tools
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:WikiProject banner shell in articles based on its TemplateData.

TemplateData for WikiProject banner shell

Aggregates and compresses the display of multiple, vertically-stacked WikiProject banner templates on pages in odd-numbered namespaces into a more information dense layout
WikiProject banners1
Place the individual project banners here, one per line
classclass
Display the standard quality assessment rating, e.g. Start, C, GA
⧼templatedata-doc-param-suggestedvalues⧽
  • FA
  • FL
  • A
  • GA
  • B
  • C
  • Start
  • Stub
  • List
⧼templatedata-doc-param-example⧽
Start
Living subjectliving
blp
Triggers the display of more verbose warnings about the extra editing constraints on these articles when set to: ['yes']
⧼templatedata-doc-param-default⧽
no
⧼templatedata-doc-param-example⧽
yes
Deceased subject with living familyblpo
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']
⧼templatedata-doc-param-default⧽
no
⧼templatedata-doc-param-example⧽
yes
Active politicianactivepol
Causes the active politician notice to appear above the shell, with warnings about extra editing restrictions, when set to: ['yes']
⧼templatedata-doc-param-default⧽
no
⧼templatedata-doc-param-example⧽
yes
Collapse project bannerscollapsed
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']
⧼templatedata-doc-param-default⧽
no
⧼templatedata-doc-param-example⧽
yes
Sort keylistas
Sets the default sort key for the current page
⧼templatedata-doc-param-example⧽
Smith, John
vitalvital
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.

Tracking categories

See also

Other shell templates