This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.
Module:WikiProject banner 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 here.
As this is a meta template, it should not be transcluded directly on to talk pages when you want to tag a page. Instead, use the template provided by the WikiProject.
WikiProject banners are categorised into a subcategory of Category:Project banner templates. It is not necessary to include a category link in the documentation for each project banner. Any project banners with issues are automatically added to Category:Project banners with errors.
The template 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.
Two different types of parameters are used: formatting and display:
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, for example |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 Interstate 80.
Simple options
PROJECT(Required) – the name of the project without the word "WikiProject", used in a variety of contexts; first letter should usually be capitalised. Eg: Interstate 80
BANNER_NAME={{subst:FULLPAGENAME}} – it is assumed that page name of the banner template is "Template:WikiProject <PROJECT>". If this is not the case then define the page name in this parameter. Eg: Template:Interstate 80 project
PROJECT_LINK – it is assumed that the project is located at "Wikipedia:WikiProject <PROJECT>". If this is not the case, then define the full link to the project page in this parameter. Eg: AARoads:Interstate 80
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>
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 "File:" prefix. Images used on WikiProject banners must be free images. Eg: I-80.svg
IMAGE_LEFT_SIZE – the size of IMAGE_LEFT. Default is 80px. Eg: 50px
IMAGE_RIGHT – the location of an image to use in the top-right corner of the banner. Do not include the "File:" prefix. Images used on WikiProject banners must be free images. Eg: I-80.svg
IMAGE_RIGHT_SIZE – the size of IMAGE_RIGHT. Default is 80px. Eg: 50px
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) Interstate 80 → "...the coverage of Interstate 80 on the AARoads Wiki...".
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.
This article falls within the topic of Interstate 80. Please visit The Interchange, where you can join the discussion and see a list of open tasks.Interstate 80AARoads:Interstate 80Template:Banner/Interstate 80Interstate 80 articles
Assessment
Many projects use the AARoads:Assessment schema to grade their articles by quality and the corresponding importance scale to place their articles in order of priority.
class(Required)– the class parameter must be passed through, if the quality scale is used. Eg: class={{{class|}}}
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.
b1, b2, b3, b4, b5, b6 – the six B-class criteria parameters.
importance– if defined, enables the standard importance scale (Top, High, Mid, Low, NA, Unknown). Eg: importance={{{importance|}}}
IMPORTANCE_SCALE – configures the importance scale, if used. The possible options are:
standard – enables the 'standard' importance scale (Top, High, Mid, Low, NA and Unknown). (This is the default behaviour.)
inline – allows for a simple custom importance scale to be defined, generally with {{Importance mask}}.
subpage – allows for a more complex custom importance 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 "Wikipedia:WikiProject <PROJECTLINK>/Assessment" then this will be used by default. To override this, you can set this parameter to no.
This article falls within the topic of Interstate 80. Please visit The Interchange, where you can join the discussion and see a list of open tasks.Interstate 80AARoads:Interstate 80Template:Banner/Interstate 80Interstate 80 articles
This article has been rated as B-class on the AARoads Wiki's content assessment scale.
Alerts and notes
Built into the module is the ability to display a number of other fields that contain useful information about the article. There are also three predefined fields for:
articles which have been automatically assessed by a bot (see above);
articles in need of immediate attention;
articles in need of an infobox.
The parameters are:
attention – pass this parameter through to enable the use of the attention note. Eg: attention={{{attention|}}}, then by including |attention=yes on the talk page.
infobox – pass this parameter through to enable the use of the needs-infobox note. Eg: infobox={{{needs-infobox|}}}, then by including |needs-infobox=yes on the talk page.
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 2, 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. 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
Example
{{#invoke:WikiProject banner|main
|PROJECT = Interstate 80
|substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
|category={{{category|}}}
|listas={{{listas|}}}
|IMAGE_LEFT = I-80.svg
|QUALITY_SCALE = extended
|class={{{class|}}}
|ASSESSMENT_LINK = AARoads:Assessment
|auto={{{auto|}}}
|AUTO_ASSESS_CAT =
|attention={{{attention|}}}
|ATTENTION_CAT =
|infobox={{{needs-infobox|}}}
|INFOBOX_CAT =
|note 1={{{needs-photo|}}}
|NOTE_1_TEXT = This page has been marked as needing a [[photograph]].
|NOTE_1_IMAGE = Gnome-dev-camera.svg
|NOTE_1_CAT = Requested photographs of Interstate 80
|note 2 = {{{audio-file|}}}
|NOTE_2_TEXT = An [[audio file format|audio file]] has been created of this article.
|NOTE_2_IMAGE = Nuvola apps arts.svg
|NOTE_2_CAT = Interstate 80 articles with audio files
}}
This article falls within the topic of Interstate 80. Please visit The Interchange, where you can join the discussion and see a list of open tasks.Interstate 80AARoads:Interstate 80Template:Banner/Interstate 80Interstate 80 articles
The module can accommodate 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={{{I-280|}}}
TF_1_LINK – the full page name of the task force's project page. Eg: AARoads:Interstate 280
TF_1_NAME – the name of the task force. This is used as the label for the task force link (unless |TF_1_TEXT= is used instead). 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 {{WikiProject banner shell}}. Eg: Interstate 280
TF_1_TEXT – if defined, replaces the default "This page is supported by..." text. E.g.: This page is within the scope of the [[AARoads:Interstate 280|Interstate 280]]. New participants 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: I-280.svg
TF_1_QUALITY – if defined, enables the quality categorisations for the main project (e.g.: Category:A-Class Interstate 280 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: Interstate 280 articles → Category:A-Class Interstate 280 articles
TF_1_HOOK – additional code to "hook" on the template only if this task force is used.
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
This article falls within the topic of Interstate 80. Please visit The Interchange, where you can join the discussion and see a list of open tasks.Interstate 80AARoads:Interstate 80Template:Banner/Interstate 80Interstate 80 articles
The features described below are non-standard and should probably not be added to a project banner without the express agreement of the WikiProject's participants.
B-class checklist
Enables a B-class checklist. There are six official criteria (although some projects use five) that an article needs to satisfy in order to be classified as B-class. A checklist can provide a helpful aid for editors to show where an article needs improvement.
B_DISPLAY_ON_START – if set to "yes", the checklist will be displayed on every Start-class article. The default behaviour is to only display on Start-class when one or more of the parameters b1-b6 have been filled in.
B_MAIN_CAT – specifies a category to use when any of the checklist parameters are blank.
B1_CAT to B6_CAT – specifies individual categories to use when the individual checklist parameters are blank or set to no.
Custom parameter names
The standard parameter names (i.e. b1, b2, etc.) should be passed as an alternative to any custom parameters (e.g. B-Class-1, B-Class-2, etc.). For example:
b1={{{B-Class-1|{{{b1|}}}}}}
If only the standard parameters are used, then eg: b1={{{b1|}}}, etc. is fine.
Collapsing task forces
By default, the list of task forces will be collapsed into a show/hide box if there are more than 5 task forces. You can configure this behaviour with the following parameters:
TF_COLLAPSE – the threshold number of task forces for them to collapse, e.g. if |TF_COLLAPSE=3 then they will collapse whenever there are more than 3 task forces.
TF_HEADER – the heading for the collapsed section. The default is Associated task forces:
To-do list
This enables a project to-do list or other similar list to be integrated into a project banner.
There are two main parameters, |TODO_LINK= and |TODO_TEXT=. Only one should be used at any time. If the to-do list is located on a different page then TODO_LINK should be used. However, if you've just got some text to include then you can use the TODO_TEXT option instead.
Styling can be adjusted using the |TODO_STYLE= and |TODO_TITLE_STYLE= parameters.
If you are using |TODO_LINK= and don't want to see the edit links at the top of the textbox, set TODO_EDITLINKS=no.
This article falls within the topic of Interstate 80. Please visit The Interchange, where you can join the discussion and see a list of open tasks.Interstate 80AARoads:Interstate 80Template:Banner/Interstate 80Interstate 80 articles
This is just a test to-do list to help editors make sure that the text
shows
up
correctly
Normally, the "/to do" subpage should only be created under the article's Talk page, unless it is a notice board or project page.
To use this template for an article, insert {{to do}} at the top of that article's Talk discussion page. To use it for a project or as your own personal list, add it to the project page or your user page, respectively.
This feature adds a note than can be used to track when articles needs an image, photograph, diagram, illustration, etc. It will populate various categories such as
It takes the following parameters:
Required parameters
image-needed – pass through whichever parameter you are using to trigger this note, e.g. |image-needed={{{needs-image|}}}.
Optional parameters
IM_IMAGE – specifies the icon to be used (without the File namespace prefix); the default is ([[File:Camera-photo.svg|20px]]).
image-type – pass through the type which can be used to accommodate other components that are needed, e.g. diagram, equation, map, etc. If this is not specified then "image or photograph" is used. E.g. |image-type={{{type|}}}.
image-details – to allow an editor to pass more details about the required image, e.g. |image-details={{{details|}}}.
image-location – pass this parameter through to allow an editor to specify the location of the requested image, e.g. |image-location={{{location|}}}. This will also populate categories of the form Category:Wikipedia requested photographs in Scotland.
IM_LOCATION_CATEGORY – a default category to use when the location is not specified or leads to a non-existent category.
image-topic – pass this through to allow an editor to specify a topic area that the photograph relates to, e.g. |image-topic={{{topic|}}}. This will populate categories such as Category:Wikipedia requested photographs of toys.
IM_TOPIC_CATEGORY – a default category in case the topic is not specified or leads to a non-existent category, e.g. |IM_TOPIC_CATEGORY=Wikipedia requested images of politics.
This featue enables a project collaboration system to be integrated into a project banner. The following parameters are used:
Required parameters
collaboration-candidate – pass the parameter that will trigger the collaboration candidate note, if used, e.g. |collaboration-candidate={{{collaboration-candidate|}}}
collaboration-current – the parameter that will trigger the current collaboration note, if used. E.g. |collaboration-current={{{collaboration|}}}
collaboration-past – the parameter that will trigger the past collaboration note, if used. e.g. |collaboration-past={{{past-collaboration|}}}
COLL_LINK – the full link to where the review for the particular article is held. E.g. |COLL_LINK=Wikipedia:WikiProject Paranormal/Collaboration
Optional parameters
COLL_TEXT – the text to display in place of the default "project collaboration", e.g. |COLL_TEXT=Collaboration of the Month
COLL_IMAGE – the name of the image to use. If not specified then is used.
COLL_CANDIDATE_CAT – if defined, pages using |candidate=yes will be categorised into this category, e.g. |COLL_CANDIDATE_CAT=Paranormal collaboration candidates → Category:Paranormal collaboration candidates
COLL_CURRENT_CAT – if defined, pages using |current=yes will be categorised into this category, e.g. |COLL_CURRENT_CAT=Paranormal collaborations → Category:Paranormal collaborations
COLL_PAST_CAT – if defined, pages using |past=yes will be categorised into this category, e.g. |COLL_PAST_CAT=Past paranormal collaborations → Category:Past paranormal collaborations
This feature enables an A-Class review process to be integrated into a project banner. The following parameters are used:
Required parameters
a class – the parameter that will trigger the note. Accepted values are "pass", "fail", "current" (any capitalisation); everything else is treated as null. Eg: a class={{{A-Class|}}}
ACR_SUBPAGE_LINK – the full link to where the review for this particular article is held. Eg: AARoads:A-Class review/{{SUBJECTPAGENAME}}
ACR_REVIEW_LINK – the full link to the main A-Class review page (where instructions etc. are held). Eg: AARoads:A-Class review/{{SUBJECTPAGENAME}}
ACR_IMAGE – a custom image can be set, using the same syntax as for other note images. Eg: Exquisite-kfind.png
ACR_SIZE – a custom image size can be set, using the usual note syntax. Eg: 20x20px
ACR_INVALID_CAT – pages specifying the A Class parameter without a valid SUBPAGE_LINK page existing will be categorised into this category.
Additional task force categories
Sometimes it is desirable to populate additional categories when certain task forces are used. For example the |attention= parameter is used to draw attention to articles which need immediate attention in the cycling project. Articles within the scope of the Tour de France task force populate the additional category of Category:Tour de France articles needing attention.
This can be achieved by using the following code:
{{#invoke:WikiProject banner|main
...
|tf 2={{{tdf|}}}
|TF_2_LINK = Wikipedia:WikiProject Cycling/Tour de France task force
...
|tf 2 cat 1={{{attention|}}}
|TF_2_CAT_1 = Tour de France articles needing attention
|tf 2 cat 2={{{needs-infobox|}}}
|TF_2_CAT_2 = Tour de France articles needing infoboxes
}}
This feature enables a peer review process to be integrated into a project banner. The following parameters are used:
Required parameters
peer review – the parameter that will trigger the active peer review note; should be passed through, e.g. |peer review={{{peer-review|}}}
old peer review – the parameter that will trigger the old peer review note; should be passed through, e.g. |old peer review={{{old-peer-review|}}}
PR_LINK – the full link to where the review for this particular article is held, e.g. |PR_LINK=AARoads:Interstate 80/Assessment
Optional parameters
PR_IMAGE – the name of the image to use. If not specified then is used.
PR_CAT – if defined, pages using |peer review=yes will be categorised into this category, e.g. |PR_CAT=Requests for Interstate 80 peer review → Category:Requests for Interstate 80 peer review
PR_OLD_CAT – if defined, pages using |old peer review=yes will be categorised into this category.
peer review title – If the page has been moved since it was reviewed, pass this parameter to specify the old page title (the one the review was archived under) to make the link point correctly to the review.
PR_INVALID_CAT – if defined, pages without a valid existing peer review page will be categorised into this category.
Inactive WikiProject banners
A number of WikiProjects have been identified as inactive or defunct (see Category:Inactive WikiProjects). In this case, the project banner can be given a less prominent form. Keeping an inactive project's template on relevant talkpages helps any group of users who later wishes to revive the project. This template will auto-categorize the project banner into Category:Inactive WikiProject banners.
The easiest way to convert a banner template to an inactive state, is to replace main with inactive.
Parameters
The only required parameter is |PROJECT= - the name of the WikiProject (but without the word "WikiProject")
An additional parameter |PROJECT_STATUS= can be used to identify the status of the inactive project. Currently recognised values are inactive and defunct. The default is inactive.
All the other parameters can and should be retained, as this will make it easier to "revive" the project in the future.
This article is within the scope of Interstate 238, a project which is currently considered to be inactive.Interstate 238AARoads:Interstate 238Template:Banner/Interstate 238Interstate 238 articles
When inside a banner shell the result is:
This module does not require a rating on the AARoads Wiki's content assessment scale.
The project banner below should be moved to this module's talk page. If this is a demonstration of the template, please set the parameter |category=no to prevent this page being miscategorized.
This module falls within the topic of AARoads Wiki. Please visit The Interchange, where you can join the discussion and see a list of open tasks.AARoads WikiMain PageTemplate:Banner/AARoads Wikiarticles
This article is within the scope of Interstate 238, a project which is currently considered to be inactive.Interstate 238AARoads:Interstate 238Template:Banner/Interstate 238Interstate 238 articles
This article is within the scope of Interstate 238, a project which is currently considered to be defunct.Interstate 238AARoads:Interstate 238Template:Banner/Interstate 238Interstate 238 articles
When inside a banner shell the result is:
This module does not require a rating on the AARoads Wiki's content assessment scale.
The project banner below should be moved to this module's talk page. If this is a demonstration of the template, please set the parameter |category=no to prevent this page being miscategorized.
This module falls within the topic of AARoads Wiki. Please visit The Interchange, where you can join the discussion and see a list of open tasks.AARoads WikiMain PageTemplate:Banner/AARoads Wikiarticles
This article is within the scope of Interstate 238, a project which is currently considered to be defunct.Interstate 238AARoads:Interstate 238Template:Banner/Interstate 238Interstate 238 articles