Jump to content

Module:WikiProject banner/doc

From Wikipedia, the free encyclopedia

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:WikiProject banner templates. Any project banners with identified issues are automatically added to Category:WikiProject 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.

There are two ways to use and configure the module:

Parameters

[edit]

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|}}}.

Syntax

[edit]
Common parameters
{{#invoke:WikiProject banner|main
|PROJECT           = 
 |substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
 |listas={{{listas|}}}
|DOC               = auto
|IMAGE_LEFT        = 
 |IMAGE_LEFT_SIZE  = 
 <!--|class={{{class|}}}-->
 <!--|auto={{{auto|}}}-->
 <!--|importance={{{importance|}}}-->
|ASSESSMENT_CAT    = 
|ASSESSMENT_LINK   = 
|MAIN_TEXT         = 
|MAIN_ARTICLE      = 
|PORTAL            = 
|MAIN_CAT          = 
<!--|attention={{{attention|}}}-->
 |ATTENTION_CAT    = 
<!--|infobox={{{needs-infobox|}}}-->
 |INFOBOX_CAT      = 
}}

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

Simple options

[edit]
  • 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 "Template:WikiProject <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 "Wikipedia:WikiProject <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>
  • 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 – fair use images are not permitted. Eg: Tulipa suaveolens floriade to Canberra.jpg
    • 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 – fair use images are not permitted. Eg: Tulipa suaveolens floriade to Canberra.jpg
    • 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) 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 Module:Portal/images. Eg: Tulips
  • MAIN_CAT – the default is no main category created; if defined, all pages displaying the template will be sorted into Category:MAIN_CAT. Eg: WikiProject Tulips articlesCategory:WikiProject Tulips articles
  • BOTTOM_TEXT – if defined, contains text that will appear across the bottom of the banner and above the collapsed section (if one is present).

Example

[edit]
{{#invoke:WikiProject banner|main
|PROJECT          = Tulips
 |substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
 |listas={{{listas|}}}
|PROJECT_LINK     = Wikipedia:Somewhere about tulips
|IMAGE_LEFT       = Tulipa suaveolens floriade to Canberra.jpg
|IMAGE_LEFT_SIZE = 50px
|MAIN_ARTICLE     = [[tulip]]s, [[liliaceae]] and related articles
}}
Produces:
WikiProject iconTulips
WikiProject iconThis article is within the scope of WikiProject Tulips, a collaborative effort to improve the coverage of tulips, liliaceae and related articles on Wikipedia. If you would like to participate, please visit the project page, where you can join the discussion and see a list of open tasks.

Assessment

[edit]

Many projects use the Wikipedia:Content 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|}}}
    • 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.
  • ASSESSMENT_CAT – articles are sorted into categories based on their quality; so "Featured Articles" on Tulips would be categorised by default into Category:FA-Class Tulips articles. To change the default, define this parameter so that featured articles are instead categorised into Category:FA-Class ASSESSMENT_CAT. Eg: |ASSESSMENT_CAT=Liliaceae articlesCategory:FA-Class Liliaceae articles

Example

[edit]
{{#invoke:WikiProject banner|main
|PROJECT             = Tulips
 |substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
 |listas={{{listas|}}}
|IMAGE_LEFT          = Tulipa suaveolens floriade to Canberra.jpg
 |class={{{class|}}}
 |auto={{{auto|}}}
 |importance={{{importance|}}}
|ASSESSMENT_LINK     = Wikipedia:WikiProject Tulips/Article grading
}}
Produces:
WikiProject iconTulips Top‑importance
WikiProject iconThis article is within the scope of WikiProject Tulips, a collaborative effort to improve the coverage of Tulips on Wikipedia. If you would like to participate, please visit the project page, where you can join the discussion and see a list of open tasks.
TopThis article has been rated as Top-importance on the project's importance scale.

Alerts and notes

[edit]

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:

  1. articles which have been automatically assessed by a bot (see above);
  2. articles in need of immediate attention;
  3. 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.
  • 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.
    • 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_CAT – if defined, all articles displaying note 1 will be categorised into Category:NOTE_1_CAT. Eg: Wikipedia requested photographs of FloridiaeCategory:Wikipedia requested photographs of Floridiae
  • 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

[edit]
{{#invoke:WikiProject banner|main
|PROJECT            = Tulips
 |substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
 |listas={{{listas|}}}
|IMAGE_LEFT         = Tulipa suaveolens floriade to Canberra.jpg
 |class={{{class|}}}
|ASSESSMENT_LINK    = Wikipedia:WikiProject Tulips/Article grading
|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        = Wikipedia requested photographs of Floridiae
|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        = Tulips articles with audio files
}}
Produces:
WikiProject iconTulips icon icon icon icon
WikiProject iconThis article is within the scope of WikiProject Tulips, a collaborative effort to improve the coverage of Tulips on Wikipedia. If you would like to participate, please visit the project page, where you can join the discussion and see a list of open tasks.
More information:
Note icon
This article has been marked as needing immediate attention.
Note icon
This article has been marked as needing an infobox.
Note icon
This page has been marked as needing a photograph.
Note icon
An audio file has been created of this article.

Task forces

[edit]

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={{{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 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: 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 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: 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= 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 articlesCategory:FA-Class Floridiae articles
    • TF_1_MAIN_CAT – if defined, all pages displaying "tf 1" will be categorised into Category:TF_1_MAIN_CAT. Eg: Floridiae articlesCategory:Floridiae 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

Example

[edit]
{{#invoke:WikiProject banner|main
|PROJECT              = Tulips
 |substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
 |listas={{{listas|}}}
|IMAGE_LEFT           = Tulipa suaveolens floriade to Canberra.jpg
 |class={{{class|}}}
|tf 1={{{floridiae|}}}
 |TF_1_LINK           = Wikipedia:WikiProject Tulips/Task forces/Floridiae
 |TF_1_NAME           = the Floridiae task force
 |TF_1_NESTED         = Floridiae
 |TF_1_TEXT           = 
 |TF_1_IMAGE          = Tulipa florenskyi 4.jpg
 |tf 1 importance={{{floridiae-importance}}}
 |TF_1_ASSESSMENT_CAT = Floridiae articles
 |TF_1_MAIN_CAT       = Floridiae articles
}}
Produces:
WikiProject iconTulips: Floridiae
WikiProject iconThis article is within the scope of WikiProject Tulips, a collaborative effort to improve the coverage of Tulips on Wikipedia. If you would like to participate, please visit the project page, where you can join the discussion and see a list of open tasks.
Taskforce icon
This article is supported by the Floridiae task force (assessed as Top-importance).

Inactive task force

[edit]

If a task force has been deemed inactive, then the following parameter and text can be used:

|TF_N_TEXT = This _PAGETYPE_ is within the scope of the [[Wikipedia:WikiProject (name of project)/(name of task force)|(name of task force)]], a task force which is currently considered to be '''[[Wikipedia:WikiProject Council/Guide#Dealing with inactive WikiProjects|inactive]]'''.
where "N" is the number of the task force, and the project and task force names are included where indicated.

Automatic documentation

[edit]
Syntax
|DOC               = auto

This module can automatically produce documentation for any project banner if requested by defining |DOC=auto. This will also build suitable TemplateData.

Other options:

  • |DOC=custom will transclude the template's own documentation page, so it is not necessary to include {{Documentation}} on the template's code.
  • |DOC=auto+custom will display the automatically produced documentation in addition to the template's own documentation page.

Configuration page

[edit]

The configurations of a project banner can be specified on a subtemplate of the banner template in JSON format. This method is still under development[a] but is used by a few projects (see list), most notably {{WikiProject Higher education}}.

The subpage is created at Template:WikiProject PROJECT/config where PROJECT is replaced with the name of the project. For an example, see Template:WikiProject Higher education/config. To change the content model to JSON it is necessary to use Special:ChangeContentModel (currently only available to template editors and administrators).

For the required structure and full list of possible settings, see Module:WikiProject banner/config page. Each setting is described below.

  • image - the main image of the template.
    • file - the name of the file, without the namespace. Maps to IMAGE_LEFT.
    • size - the size of the image. Maps to IMAGE_LEFT_SIZE.
  • text - the main text to display on the banner. Maps to MAIN_TEXT.
  • category - a category for all articles to be placed in. Maps to MAIN_CAT.
  • assessment - contains the assessment options for the project banner.
    • quality - set to true to categorise using the quality assessment inherited from the banner shell.
    • priority - set to true to assess priority or importance.
    • link - a page which gives the project's priority scale. Maps to ASSESSMENT_LINK.
    • topic - the root name of the category tree used to assess articles. Maps to ASSESSMENT_CAT.
  • taskforces - contains details of all task forces and subprojects.
    • header - text to be displayed in header if task forces get collapsed. Maps to TF_HEADER.
    • collapse - the number of task forces to be present to cause them to be collapsed. Maps to TF_COLLAPSE.
    • size - default size for all task force images. Maps to TF_SIZE.
    • list - array of each task force with required settings.
  • notes - contains details of all notes and alerts used by the banner.
    • header - text to be displayed in header if notes get collapsed. Maps to COLLAPSED_HEAD.
    • collapse - the number of notes to be present to cause them to be collapsed. Maps to COLLAPSED.
    • size - default size for all note images. Maps to NOTE_SIZE.
    • attention - settings for the attention-needed note.
      • parameter - the name of the parameter which triggers this note, e.g. "attention-needed". To include a list of accepted aliases use an array, e.g. ["attention", "attention-needed"]
      • category - the name of the category, without the namespace. Maps to ATTENTION_CAT.
    • infobox - settings for the infobox-needed note.
      • parameter - the name of the parameter which triggers this note, e.g. "infobox-needed".
      • category - the name of the category, without the namespace. Maps to INFOBOX_CAT.
    • auto - settings for the automatic assessment note.
      • parameter - the name of the parameter which triggers this note, e.g. "auto".
      • category - the name of the category, without the namespace. Maps to AUTO_ASSESS_CAT.
    • list - array of each note with required settings.

Advanced features

[edit]

A number of extra functions not frequently used by the main module are available to support the following features:

  • B-class checklist
  • To-do list
  • Assessment category intersection
  • Image-needed note
  • Collaboration note
  • A-class review note
  • Peer review note

Please see Module:WikiProject banner/auxiliary for details of how to use these.

Additional task force categories

[edit]

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
}}

Custom masks

[edit]

The module 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 the default. To achieve this, create the mask template in the /class subpage of your project banner template and set |QUALITY_CRITERIA=custom. Note that this will remove the project from project-independent quality assessments, and so no assessments will be inherited from other projects.

Inactive WikiProject banners

[edit]

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

[edit]
  • 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.

Examples

[edit]
{{#invoke:WikiProject banner|inactive
 |PROJECT     = Extreme sports
}}
produces:
WikiProject iconExtreme sports (inactive)
WikiProject iconThis article is within the scope of WikiProject Extreme sports, a project which is currently considered to be inactive.
When inside a banner shell the result is:
{{#invoke:WikiProject banner|inactive
 |PROJECT        = Policy and Guidelines
 |PROJECT_STATUS = defunct
}}
produces:
WikiProject iconPolicy and Guidelines (defunct)
WikiProject iconThis article is within the scope of WikiProject Policy and Guidelines, a project which is currently considered to be defunct.
When inside a banner shell the result is:

Notes

[edit]
  1. ^ As of 26 November 2025

See also

[edit]