Template:WPBannerMeta/hooks/bchecklist/doc

This is a documentation subpage for Template:Terminate sentence
It may contain usage information, categories and other content that is not part of the original template page.

Shortcut

WP:BCHECKLIST

This template is used on 2,790,000+ pages, or roughly 1019% of all pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This is the bchecklist hook which enables a B-class checklist to be incorporated into a banner template. There are six official criteria (although some projects use five) that an article needs to satisfy in order to be classified as B-class. A checklist can provide a helpful aid for editors to show where an article needs improvement.

When used in conjunction with a custom class mask, articles can be automatically demoted to C-class if they don't satisfy all of the criteria.

Syntax

{{WPBannerMeta
|PROJECT               = 
 |BANNER_NAME          = {{subst:FULLPAGENAME}}
 |category={{{category|}}}
 |listas = {{{listas|}}}

...

|HOOK_ASSESS = {{WPBannerMeta/hooks/bchecklist
 |BANNER_NAME={{subst:FULLPAGENAME}}
 |category={{{category|}}}
 |class={{{class|}}}
 |b1={{{b1|}}}
 |b2={{{b2|}}}
 |b3={{{b3|}}}
 |b4={{{b4|}}}
 |b5={{{b5|}}}
 |b6={{{b6|}}}
 |ASSESSMENT_LINK     = 
}}

Required parameters

BANNER_NAME – needs to be passed, so that all the checklist will display on the template itself.
category – needs to be passed through.
class – needs to be passed so that the checklist is only displayed when it is appropriate;
The six B-Class criteria: b1, b2, b3, b4, b5, b6

Optional parameters

ASSESSMENT_LINK – specifies a link to a custom assessment scale. If this is not specified, then the standard scale Wikipedia:Version 1.0 Editorial Team/Assessment/B-Class criteria will be used.
DISPLAY_ON_START – if set to "yes", the checklist will be displayed on every Start-class article. The default behaviour is to only display on Start-class when one or more of the parameters b1-b6 have been filled in.

Category parameters

MAIN_CAT – specifies a category to use when any of the checklist parameters are blank.
B1_CAT to B6_CAT – specifies individual categories to use when the individual checklist parameters are blank or set to no.

Custom parameter names

The standard parameter names (i.e. b1, b2, etc.) should be passed as an alternative to any custom parameters (e.g. B-Class-1, B-Class-2, etc.).

This is achieved by replacing **PARAMETER** with the name of the parameter. For example:

b1={{{B-Class-1|{{{b1|}}}}}}

If only the standard parameters are used, then eg: b1={{{b1|}}}, etc. is fine.

Subtemplates

These are listed for technical background only.

/core - the code which actually produces the checklist
/criterion - code for each criterion
/syntax - for separate lines of the copy/paste code