Template:WPBannerMeta/hooks/collaboration/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 1,170,000+ pages, or roughly 427% 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/collaboration
 |BANNER_NAME        = {{subst:FULLPAGENAME}}
 |category={{{category|}}}
 |candidate          = {{{**PARAMETER**|}}}
 |current            = {{{**PARAMETER**|}}}
 |past               = {{{**PARAMETER**|}}}
 |LINK               = 
 |TEXT               =
 |IMAGE              = 
 |CANDIDATE_CAT      = 
 |CURRENT_CAT        = 
 |PAST_CAT           = 
}}

...

}}

This hook enables a project collaboration system to be integrated into a project banner. It should be attached to the |HOOK_NOTE= hook. The following parameters are used:

category (Required) – the 'category' parameter must be passed through the template to enable category optout. Eg: category={{{category|}}}
candidate – the parameter that will trigger the collaboration candidate note, if used. Eg: candidate={{{collaboration-candidate|}}}
current – the parameter that will trigger the current collaboration note, if used. Eg: current={{{collaboration|}}}
past – the parameter that will trigger the past collaboration note, if used. Eg: past={{{past-collaboration|}}}
LINK (Required) – the full link to where the review for this particular article is held. Eg: Wikipedia:WikiProject Tulips/Assessment/{{SUBJECTPAGENAME}}
TEXT – the text to display in place of the default "project collaboration". Eg: Collaboration of the Month
IMAGE – the name of the image to use. If not specified then is used.
CANDIDATE_CAT – if defined, pages using |candidate=yes will be categorised into this category. Eg: Tulip collaboration candidates → Category:Tulip collaboration candidates
CURRENT_CAT – if defined, pages using |current=yes will be categorised into this category. Eg: Current Tulip collaborations → Category:Current Tulip collaborations
PAST_CAT – if defined, pages using |past=yes will be categorised into this category. Eg: Past Tulip collaborations → Category:Past Tulip collaborations