Template:WPBannerMeta/hooks/aclass/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.

This template is used on approximately 2,350,000 pages, or roughly 862% 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.

Syntax

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

...

|HOOK_NOTE              = <!--
-->{{WPBannerMeta/hooks/aclass
 |BANNER_NAME           = {{subst:FULLPAGENAME}}
 |a class={{{**PARAMETER**|}}}
 |category={{{category|}}}
 |SUBPAGE_LINK          = 
 |REVIEW_LINK           = 
 |PASS_CAT              = 
 |FAIL_CAT              = 
 |CURRENT_CAT           = 
}}

...

}}

This hook enables an A-Class review process to be integrated into a project banner. It should be attached to the |HOOK_NOTE= hook. The following parameters are used:

a class (Required) – the parameter that will trigger the note. Accepted values are "pass", "fail", "current" (any capitalisation); everything else is treated as null. Eg: a class={{{A-Class|}}}
category (Required) – the 'category' parameter must be passed through the template to enable category optout. Eg: category={{{category|}}}
SUBPAGE_LINK (Required) – the full link to where the review for this particular article is held. Eg: Wikipedia:WikiProject Tulips/Assessment/{{SUBJECTPAGENAME}}
REVIEW_LINK (Required) – the full link to the main A-Class review page (where instructions etc. are held). Eg: Wikipedia:WikiProject Tulips/Review#A-Class review
PASS_CAT – if defined, pages using |a class=pass will be categorised into this category. Eg: Successful requests for Tulips A-Class review → Category:Successful requests for Tulips A-Class review
FAIL_CAT – if defined, pages using |a class=fail will be categorised into this category. Eg: Failed requests for Tulips A-Class review → Category:Failed requests for Tulips A-Class review
CURRENT_CAT – if defined, pages using |a class=current will be categorised into this category. Eg: Current requests for Tulips A-Class review → Category:Current requests for Tulips A-Class review
IMAGE – a custom image can be set, using the same syntax as for other note images. Eg: Exquisite-kfind.png
SIZE – a custom image size can be set, using the usual note syntax. Eg: 20x20px
FORMAT – custom formatting can be set, using the usual syntax. Note that the default blue background will be overridden by anything you put in here. Eg: style="background:transparent;"
INVALID_CAT – if defined, pages specifying the A Class parameter without a valid SUBPAGE_LINK page existing be categorised into this category.