টেমপ্লেট:WPBannerMeta

The WikiProject banner below should be moved to this টেমপ্লেট's talk page.

If this is a demonstration of the template, please set the parameter |category=no to prevent this page being miscategorised. If this message appears on the template page itself, please check that the value of the |BANNER_NAME= parameter is correctly set to টেমপ্লেট:WPBannerMeta.

WPBannerMeta is a meta-template, which can be used to create WikiProject banners, enabling new projects to easily create a banner to place on article talk pages, ensuring standardisation between projects. A list of all WikiProject banners using this meta-template can be found at What links here: WPBannerMeta

This is a meta template. It is used to build other templates. Do not transclude this template directly on to talk pages when you want to tag a page. Instead, use the template produced by the WikiProject.

WPBannerMeta can be used at varying levels of complexity, from the very simple to the extremely complicated. Simple options are listed here first, with complexity increasing down the page.

WPBannerMeta takes two different types of parameters, formatting and display. The formatting parameters customise the meta-template for a particular project, defining link targets, categories, images and text. All formatting parameters use UPPERCASE and underscores (_), instead of spaces (e.g. |PROJECT= and |NOTE_1_CAT= ). Display parameters customise the template output for each individual article that the banner is displayed on. These are the parameters which are entered on the talk page (|class=, |importance=, etc.) and they must be 'passed through' the project banner to the meta-template underneath. To 'pass' the parameter foo, you need to include the code foo={{{foo|}}}.

In the examples below, a WikiProject banner will be constructed for the (currently) nonexistent WikiProject Tulips.

PROJECT(Required) – the name of the project without the word "WikiProject", used in a variety of contexts; first letter should usually be capitalised. Eg: Tulips

BANNER_NAME={{subst:FULLPAGENAME}} – it is assumed that page name of the banner template is "টেমপ্লেট:উইকিপ্রকল্প <PROJECT>". If this is not the case then define the page name in this parameter. Eg: Template:Tulips project

PROJECT_LINK – it is assumed that the project is located at "উইকিপিডিয়া:উইকিপ্রকল্প <PROJECT>". If this is not the case, then define the full link to the project page in this parameter. Eg: Wikipedia:WikiProject Tulips

PROJECT_NAME – if your project is not called "WikiProject <PROJECT>" then define the exact name of the project with this parameter.

substcheck – this allows the template to detect if it has been substituted instead of transcluded and give an error message. substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>

small(Required) – the size parameter must be passed through the template to enable the correct display. Eg: small={{{small|}}}

category(Required) – the 'category' parameter must be passed through the template to enable category optout. E.g.: category={{{category|¬}}}.

listas(Required) – the 'listas' parameter must be passed through the template. Eg: listas={{{listas|}}}

IMAGE_LEFT – the location of an image to use in the top-left corner of the banner. Do not include the "Image:" prefix. Images used on WikiProject banners must be free images – fair use images are not permitted. Eg: Tulip - floriade canberra.jpg

IMAGE_LEFT_SMALL – the size of IMAGE_LEFT, when the banner is displayed in 'small style'. Default is 40px. Eg: 25px

IMAGE_RIGHT – the location of an image to use in the top-right corner of the banner. Do not include the "Image:" prefix. Images used on WikiProject banners must be free images – fair use images are not permitted. Eg: Tulip - floriade canberra.jpg

IMAGE_RIGHT_SMALL – the size of IMAGE_RIGHT, when the banner is displayed in 'small style'. Default is 40px. Eg: 25px

MAIN_TEXT – the default text is "This article is within the scope of [[WikiProject {{{PROJECT_LINK}}}]], a collaborative effort to improve the coverage of {{{PROJECT or MAIN_ARTICLE}}} articles on Wikipedia. If you would like to participate, please visit the project page, where you can join the [[Talk:{{{PROJECT_LINK}}}]] discussion and see a list of open tasks." If defined, the alternate message will be displayed.

MAIN_ARTICLE – the default article is PROJECT; alternatively, the linked article can be changed to either a raw article title or more complicated text. Eg: (default) tulips → "...the coverage of tulips on Wikipedia..."or (alternate) [[tulip]]s, [[liliaceae]] and related articles → "...the coverage of tulips, liliaceae and related articles on Wikipedia..."

PORTAL – if the WikiProject maintains a portal, define this parameter with the portal name. The associated image is held centrally at Template:Portal/images. Eg: Tulips

BOTTOM_TEXT – if defined, contains text that will appear across the bottom of the banner and above the collapsed section (if one is present). Please do not use this parameter to 'hook' extra code to the bottom of the template – see the hooks section below for a better solution.

Many projects use the Version 1.0 Assessment schema to grade their articles by quality and the corresponding importance scale to place their articles in order of priority. In order to implement WP:1.0, which uses a bot to automatically compile its statistics tables, you will need to follow the instructions at /Using the bot, as well as those outlined here.

class(Required)– the class parameter must be passed through, if the quality scale is used. Eg: class={{{class|}}}

inline – allows for a simple custom quality scale to be used, generally used with {{Class mask}}.

subpage – allows for a more complex custom quality scale to be used using a subpage called /class. See custom masks below for further details.

auto the auto parameter must be passed through, if the auto assess option is needed. Eg: auto={{{auto|}}} Projects which use bots to automatically categorise articles can have the bot add the following parameter to the project banner, which triggers the display of a small notice that the article was tagged by a bot rather than a human:

|auto=stub, for an article which includes a stub template, to indicate that it has automatically been rated Stub-class;

|auto=inherit, to show that the class has automatically been inherited from other WikiProject's assessments on the same page;

|auto=length, to show that the class has automatically been deduced from the length of the article.

inline – allows for a simple custom importance or priority scale to be defined, generally with {{Importance mask}}.

subpage – allows for a more complex custom importance/priority scale to be used using a subpage called /importance.

ASSESSMENT_LINK – the link to a WikiProject-specific quality (and/or importance) scale. If there is a page at "উইকিপিডিয়া:উইকিপ্রকল্প <PROJECTLINK>/মূল্যায়ন" then this will be used by default. To override this, you can set this parameter to no. For more details, see here.

COMMENTS– some projects may want to use a subpage of the article's talk page to post brief, assessment-related comments about the article. If these comments are placed in a "{{FULLPAGENAME}}/Comments" subpage, then this parameter will cause a link to automatically display. Eg: yes

COMMENTS_SHOW_INLINE– if this parameter is defined, the comments will be shown inline rather than as a link.

note 1– pass this parameter through to trigger any defined note. Eg: note 1={{{needs-photo|}}}, then by including |needs-photo=yes on the talk page. Up to ten notes can be specified in the core banner.

NOTE_1_TEXT – the text of note 1. E.g.: This page has been marked as needing a photograph. If this is left blank there is no visual output.

NOTE_1_IMAGE – an image can be defined for each note. Remember that all images must be free, not fair-use. Eg: Gnome-dev-camera.svg

NOTE_1_FORMAT – optional formatting (colour, etc.) for the table cell which contains the image, if any, for the note. Eg: style="background:blue"

COLLAPSED – when more than a threshold number of notes and alerts are triggered on a page, they are automagically collapsed into a show/hide box. The threshold number can be customised by setting this parameter to the maximum number of notes on a page that will not trigger the collapse. The default is 3, so if three notes are triggered on a page, they will not be collapsed, but if a fourth is also triggered, the collapse box appears. So setting |COLLAPSED=0 will always create a collapse box (if there are any notes to fill it), while |COLLAPSED=999 will never trigger a collapse box. See also the /notecounter hook. Eg: 6

COLLAPSED_HEAD – the heading for the collapsed section; the default is More information:Eg: Additional information:

NOTE_SIZE – the size of the image used for the 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

WPBannerMeta can accommodate up to five task forces, each with its own image, links and importance scale, if desired. The following parameters are available:

tf 1 – this parameter must be passed through to enable and trigger the display of the task force section. Eg: tf 1={{{floridiae|}}}

TF_1_LINK – the full page name of the task force's project page. Eg: Wikipedia:WikiProject Tulips/Task forces/Floridiae

TF_1_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_1_NESTED – if defined, a link of the form "/ [[{{{TF_1_LINK}}}|{{{TF_1_NESTED}}}]]" is added after the main project's name when the banner is collapsed inside a {{WikiProjectBannerShell}}. Eg: Floridiae

TF_1_TEXT – if defined, replaces the default "This page is supported by..." text. E.g.: This page is within the scope of the [[Wikipedia:WikiProject Tulips/Task forces/Floridiae|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_1_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_1_QUALITY – if defined, enables the quality categorisations for the main project (e.g.: Category:FA-Class Tulips articles) to be duplicated for the task force. The class arising from |class= and |QUALITY_SCALE= will be used; Eg: yes

tf 1 importance– if defined, enables the use of a separate importance (or priority, if used) scale for the task force.Eg: tf 1 importance={{{floridiae-importance|}}}

TF_1_ASSESSMENT_CAT(Required if quality or importance assessments are used) – the assessment category to be used for the task force-specific quality and importance assessments. Identical in syntax to |ASSESSMENT_CAT=. Eg: Floridiae articles → Category:FA-Class Floridiae articles

TF_SIZE – the size of the taskforce 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

WPBannerMeta 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 (|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 of Template:WPBannerMeta/hooks and add it to the list on that page.

WPBannerMeta uses a mask to normalise the values given to the |class= parameter, to ensure that invalid inputs are discarded (e.g. |class=cheesecake) and that equivalent inputs appear the same (e.g. |class=FA and |class=fA). This mask effectively controls which extended assessment scale values are accepted by the template (e.g. "Template-Class", "Redirect-Class", etc.). Projects which want to use more obscure assessment classes (e.g. "Future-Class", "Bplus-Class", etc.) or to not use all of the standard classes (e.g. not using "C-Class") can define their own custom mask, which will override WPBannerMeta's default.

This meta-template automatically categorises all instances (i.e. specific project banners) into a subcategory of Category:WikiProject banners. It is not necessary to include a category link in the documentation for each project banner.