Template:WPBannerMeta/hooks/collaboration/doc

From MOASSpedia
Jump to navigation Jump to search
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 Crystal 128 kuser.png is used.
  • CANDIDATE_CAT – if defined, pages using |candidate=yes will be categorised into this category. Eg: Tulip collaboration candidatesCategory:Tulip collaboration candidates
  • CURRENT_CAT – if defined, pages using |current=yes will be categorised into this category. Eg: Current Tulip collaborationsCategory:Current Tulip collaborations
  • PAST_CAT – if defined, pages using |past=yes will be categorised into this category. Eg: Past Tulip collaborationsCategory:Past Tulip collaborations