Template:WPBannerMeta/hooks
Template documentationWPBannerMeta incorporates a number of 'hooks', where advanced or customised features can be added. These should take the form of a subtemplate passed to the relevant hook parameter. Any relevant parameters should then be passed to the hook template—it may be necessary to repeat parameters that are already passed to the main template (eg: |category={{{category|¬}}} and |class={{{class|}}} are commonly used). If you write a hook that you think other projects could use, please copy or move it to a subpage here and add it to the list below. All hooks that are subpages of this page should be fully protected.
Writing a hook
Hooks should be carefully designed to mimic the meta-functionality of the WPBannerMeta template, particularly with things like category opt-out and case-insensitive class filtering; and for ease of maintenance, the parameters should be similarly named to WPBannerMeta's default parameters.
Available hook parameters
|HOOK_ASSESS=– between the code for quality and importance assessments.|HOOK_BOTTOM=– just below the comments display, adjacent to|BOTTOM_TEXT=. Please use this hook rather than the|BOTTOM_TEXT=parameter, for adding extra functionality to the bottom of the template.|HOOK_NOTE=– after the last note code (above the comment display).|HOOK_COLLAPSED=– added to the 'counter' that counts the number of notes that have been triggered on a page, to prompt the collapsible box. Accepts either- any valid input to the
#exprParserFunction. - "auto", which automatically sets to 1 if HOOK_NOTE is non-empty and 0 otherwise. This is the default setting and is suitable if HOOK_NOTE will not normally produce more than one row of output.
- any valid input to the
|HOOK_IMPORTANCE=– between the importance assessment and the autoassess notice.|HOOK_NESTED=– after the taskforce list that is displayed when the banner is nested within a {{WikiProject banner shell}}.|HOOK_NESTED_ASSESS=– before or instead of the quality and importance assessment when the banner is nested - utilised by Template:Inactive WikiProject banner|HOOK_TF=– after the taskforce code (just above the code for|attention=).
Existing hooks
- /aclass – enables an A-Class review process to be integrated into the banner.
- /article todolist – allows for easy adding of a article specific to-do list (hooks to
|HOOK_BOTTOM=). - /bchecklist – enables a B-class checklist
- /cats – add categories based on parameters with proper optout, case insensitivity, etc.
- /collaboration – enables integration of project collaboration into the banner.
- /collapsed – enables adding another collapsed section.
- /image needed – adds an alert that an image is requested for the article.
- /notecounter – allows notes, etc. added in HOOK_NOTE to contribute towards the counter that triggers the notes being collapsed.
- /notes – provides ten additional notes. Hooks to
|HOOK_NOTE=. - /numerical ratings – needs documentation.
- /peerreview – enables peer review functions.
- /qualimpintersect – allows for quality and importance category intersection.
- /qualitycats – enables categorisation with an additional quality scale.
- /taskforces – provides ten additional taskforces (hooks to
|HOOK_TF=). - /tfnested – nested summaries for ten additional taskforces. Works with /taskforces above. Hooks to
|HOOK_NESTED=. - /todolist – allows for easy adding of a project wide to-do list (hooks to
|HOOK_BOTTOM=).