Template:WPBannerMeta/hooks/taskforces/doc

From Wikibooks, open books for an open world
Jump to navigation Jump to search
Syntax
{{WPBannerMeta
|PROJECT               = 
 |BANNER_NAME          = {{subst:FULLPAGENAME}}
 |small={{{small|}}}
 |category={{{category|¬}}}
 |listas = {{{listas|}}}

...

|HOOK_TF = {{WPBannerMeta/hooks/taskforces
 |category={{{category|}}}
 |BANNER_NAME           = {{subst:FULLPAGENAME}}
 |QUALITY_SCALE         = 
 |quality={{{quality|}}}
 |PRIORITY_SCALE      = 
 |tf 1={{{**PARAMETER**|}}}
  |TF_1_LINK            = 
  |TF_1_NAME            = 
  |TF_1_IMAGE           = 
   |TF_1_SIZE           = 
  |TF_1_TEXT            = 
  |TF_1_QUALITY         = 
  |tf 1 priority={{{**PARAMETER**|}}}
  |TF_1_ASSESSMENT_CAT = 
  |TF_1_MAIN_CAT        = 
 |tf 2={{{**PARAMETER**|}}}
  |TF_2_LINK            = 
  |TF_2_NAME            = 
  |TF_2_IMAGE           = 
   |TF_2_SIZE           = 
  |TF_2_TEXT            = 
  |TF_2_QUALITY         = 
  |tf 2 priority={{{**PARAMETER**|}}}
  |TF_2_ASSESSMENT_CAT = 
  |TF_2_MAIN_CAT        = 
 |tf 3={{{**PARAMETER**|}}}
  |TF_3_LINK            = 
  |TF_3_NAME            = 
  |TF_3_IMAGE           = 
   |TF_3_SIZE           = 
  |TF_3_TEXT            = 
  |TF_3_QUALITY         = 
  |tf 3 priority={{{**PARAMETER**|}}}
  |TF_3_ASSESSMENT_CAT = 
  |TF_3_MAIN_CAT        = 
 |tf 4={{{**PARAMETER**|}}}
  |TF_4_LINK            = 
  |TF_4_NAME            = 
  |TF_4_IMAGE           = 
   |TF_4_SIZE           = 
  |TF_4_TEXT            = 
  |TF_4_QUALITY         = 
  |tf 4 priority={{{**PARAMETER**|}}}
  |TF_4_ASSESSMENT_CAT = 
  |TF_4_MAIN_CAT        = 
 |tf 5={{{**PARAMETER**|}}}
  |TF_5_LINK            = 
  |TF_5_NAME            = 
  |TF_5_IMAGE           = 
   |TF_5_SIZE           = 
  |TF_5_TEXT            = 
  |TF_5_QUALITY         = 
  |tf 5 priority={{{**PARAMETER**|}}}
  |TF_5_ASSESSMENT_CAT = 
  |TF_5_MAIN_CAT        = 
 |tf 6={{{**PARAMETER**|}}}
  |TF_6_LINK            = 
  |TF_6_NAME            = 
  |TF_6_IMAGE           = 
   |TF_6_SIZE           = 
  |TF_6_TEXT            = 
  |TF_6_QUALITY         = 
  |tf 6 priority={{{**PARAMETER**|}}}
  |TF_6_ASSESSMENT_CAT = 
  |TF_6_MAIN_CAT        = 
 |tf 7={{{**PARAMETER**|}}}
  |TF_7_LINK            = 
  |TF_7_NAME            = 
  |TF_7_IMAGE           = 
   |TF_7_SIZE           = 
  |TF_7_TEXT            = 
  |TF_7_QUALITY         = 
  |tf 7 priority={{{**PARAMETER**|}}}
  |TF_7_ASSESSMENT_CAT = 
  |TF_7_MAIN_CAT        = 
 |tf 8={{{**PARAMETER**|}}}
  |TF_8_LINK            = 
  |TF_8_NAME            = 
  |TF_8_IMAGE           = 
   |TF_8_SIZE           = 
  |TF_8_TEXT            = 
  |TF_8_QUALITY         = 
  |tf 8 priority={{{**PARAMETER**|}}}
  |TF_8_ASSESSMENT_CAT = 
  |TF_8_MAIN_CAT        = 
 |tf 9={{{**PARAMETER**|}}}
  |TF_9_LINK            = 
  |TF_9_NAME            = 
  |TF_9_IMAGE           = 
   |TF_9_SIZE           = 
  |TF_9_TEXT            = 
  |TF_9_QUALITY         = 
  |tf 9 priority={{{**PARAMETER**|}}}
  |TF_9_ASSESSMENT_CAT = 
  |TF_9_MAIN_CAT        = 
 |tf 10={{{**PARAMETER**|}}}
  |TF_10_LINK            = 
  |TF_10_NAME            = 
  |TF_10_IMAGE           = 
   |TF_10_SIZE           = 
  |TF_10_TEXT            = 
  |TF_10_QUALITY         = 
  |tf 10 priority={{{**PARAMETER**|}}}
  |TF_10_ASSESSMENT_CAT = 
  |TF_10_MAIN_CAT        = 
}}

...

}}

This hook allows the use of up to ten additional task forces, over the five already supported in the main banner code. It should be hung on |HOOK_TF=. The parameters have the same names and functions as in the standard implementation, although a few additional features are available with this hook. They are:

  • BANNER_NAME – needs to be passed, so that all the task forces will display on the template itself.
  • category – needs to be passed, i.e. |category={{{category|}}}
  • QUALITY_SCALE – note that it is necessary to re-specify |QUALITY_SCALE= as it is used by the subtemplates involved.
    • quality – needs to be passed, i.e. |quality={{{quality|}}}
  • PRIORITY_SCALE – needs to be respecified.
  • TF_SIZE – the default size of the task force icons. (It is recommended to precede the size with "x" as this specifies the height of the image instead of the width, which results in a neater banner because all rows have equal height.) The default is a height of 25px. Eg: x30px
  • tf n – this parameter must be passed through to enable and trigger the display of the task force section. Eg: tf 1={{{floridiae|}}}
    • TF_n_LINK – the full page name of the task force's project page. Eg: Wikibooks:WikiProject Tulips/Task forces/Floridiae
    • TF_n_NAME – the way the task force's name will appear in its piped link; redundant when |TF_1_TEXT= is used. Eg: the Floridiae task force
    • TF_n_TEXT – if defined, replaces the default "This page is supported by..." text. Eg: This page is within the scope of the ''Floridiae task force''. New members are always welcome! If defined to be "none", then no output will be displayed, although appropriate categories will still be added.
    • TF_n_IMAGE – an image can be defined for each task force. Remember that all images must be free, not fair-use. Eg: Tulipa florenskyi 4.jpg
    • TF_n_SIZE – the size of the task force icon, which will override the TF_SIZE parameter, if set. (Again, it is recommended to precede the size with "x" as this specifies the height of the image instead of the width.) Eg: x30px
    • TF_n_QUALITY – if defined, enables the quality categorizations for the main project (e.g.: Category:FB-quality Tulips pages) to be duplicated for the task force. The quality arising from |quality= and |QUALITY_SCALE= will be used; Eg: yes
    • tf n priority– if defined, enables the use of a separate priority (or importance, if used) scale for the task force.Eg: tf 1 priority={{{floridiae-priority|}}}
    • TF_n_ASSESSMENT_CAT (Required if quality or priority assessments are used) – the assessment category to be used for the task force-specific quality and priority assessments. Identical in syntax to |ASSESSMENT_CAT=. Eg: Floridiae pages → Category:FB-quality Floridiae pages
    • TF_n_MAIN_CAT – if defined, all pages displaying "tf 1" will be categorized into Category:TF_1_MAIN_CAT. Eg: Floridiae pages → Category:Floridiae pages
    • TF_n_SUBJECT – may be used to include links to subjects which are specific to particular task forces.
    • TF_n_HOOK – enables extra code to be triggered by each task force parameter (for example, additional categories, with the use of the /cats hook);

It will also be necessary to use Template:WPBannerMeta/hooks/tfnested if you want to display the "/ project" for each taskforce when the banner is nested.