Module:WikiProject banner

Module:WikiProject banner implements {{WikiProject banner shell}} and 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. 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:WikiProject banners with errors.

Syntax

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

Parameters

Common parameters
<syntaxhighlight lang="wikitext" style="font-size: 100%; width: 100%;"> </syntaxhighlight>

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

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: 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. <syntaxhighlight lang="wikitext" inline>substcheck={{subst:substcheck}}</syntaxhighlight>
• 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 articles → Category: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). 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.

Example

<syntaxhighlight lang="wikitext" style="font-size: 100%"> </syntaxhighlight>

Produces:

Assessment

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.

    • AUTO_ASSESS_CAT – if defined, all articles with the |auto= parameter will be categorised into Category:AUTO_ASSESS_CAT. By default, they are categorised into Category:Automatically assessed PROJECT articles. Eg: Automatically assessed Tulip and Daffodil articles → Category:Automatically assessed Tulip and Daffodil articles
  • 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 <syntaxhighlight lang="text" class="" id="" style="" inline="1">ASSESSMENT_CAT</syntaxhighlight>. Eg: |ASSESSMENT_CAT=Liliaceae articles → Category:FA-Class Liliaceae articles

Example

<syntaxhighlight lang="wikitext" style="font-size: 100%"> </syntaxhighlight>

Produces:

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:

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.
  • ATTENTION_CAT – if defined, all articles displaying the attention note will be categorised into Category:ATTENTION_CAT. By default, they are categorised into Category:PROJECT articles needing attention. Eg: Floridiae taskforce articles needing attention → Category:Floridiae taskforce articles needing attention. A value of none results in no categorisation.
• 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.
  • INFOBOX_CAT – if defined, all articles displaying the needs-infobox note will be categorised into Category:INFOBOX_CAT. By default, they are categorised into Category:PROJECT articles needing infoboxes. Eg: Floridiae taskforce articles needing infoboxes → Category:Floridiae taskforce articles needing infoboxes. A value of none results in no categorisation.
• 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 Floridiae → Category: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

<syntaxhighlight lang="wikitext" style="font-size: 100%"> </syntaxhighlight>

Produces:

Task forces

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

<syntaxhighlight lang="wikitext" style="font-size: 100%"> </syntaxhighlight>

Produces:

Inactive task force

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 "NTemplate:Thin space" is the number of the task force, and the project and task force names are included where indicated.

Advanced features

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.

Syntax
<syntaxhighlight lang="wikitext"> </syntaxhighlight>

Required parameters

• The six B-Class criteria: b1, b2, b3, b4, b5, b6

Optional parameters

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

Syntax
<syntaxhighlight lang="wikitext" style="font-size:90%">	TODO_LINK =	TODO_TEXT =	TODO_TITLE =	TODO_STYLE =	TODO_TITLE_STYLE=	TODO_EDITLINKS = </syntaxhighlight>

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.

Example

<syntaxhighlight lang="wikitext"> </syntaxhighlight>

Produces:

Quality/importance category intersection

This feature adds categories which combine quality and importance such as Category:Start-Class High-importance Kent-related articles. It has no visible output.

It takes the following parameters:

Required parameters

• QII_FORMAT – the format of the category names. The C, I and T are replaced by the class, importance and topic respectively. For example:
  • I C T, e.g. Category:Mid-importance B-Class Geology articles
  • C T of I, e.g. Category:C-Class Andhra Pradesh articles of Low-importance
  • C I T, e.g. Category:B-Class High-importance Pornography articles
  • C, I T, e.g. Category:Stub-Class, Top-importance Economics articles

Optional parameters

• QII_SUPPRESS_NA – can be set to yes to stop categories being added when either class or importance is "NA". These can also be set individually:
  • QII_SUPPRESS_NA_CLASS – can be set to yes to stop categories being added when class=NA
  • QII_SUPPRESS_NA_IMPORTANCE – can be set to yes to stop categories being added when importance=NA
• QII_UNASSESSED_APPENDIX – text to append to the class when it is "Unassessed", e.g. |QII_UNASSESSED_APPENDIX=-Class

Image-needed note

Syntax
<syntaxhighlight lang="wikitext">	image-needed=	IM_IMAGE =	image-details=	image-location=	IM_LOCATION_CATEGORY =	image-topic=	IM_TOPIC_CATEGORY =	image-type= </syntaxhighlight>

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.

Collaboration note

Syntax
<syntaxhighlight lang="wikitext">	collaboration-candidate=	collaboration-current=	collaboration-past=	COLL_LINK =	COLL_TEXT =	COLL_IMAGE =	COLL_CANDIDATE_CAT =	COLL_CURRENT_CAT =	COLL_PAST_CAT = </syntaxhighlight>

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

A-class review note

Syntax
<syntaxhighlight lang="wikitext">	a class=	ACR_SUBPAGE_LINK =	ACR_REVIEW_LINK =	ACR_PASS_CAT =	ACR_FAIL_CAT =	ACR_CURRENT_CAT =	ACR_PRELOAD = </syntaxhighlight>

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: Wikipedia:WikiProject Tulips/Assessment/{{SUBJECTPAGENAME}}
• ACR_REVIEW_LINK – the full link to the main A-Class review page (where instructions etc. are held). Eg: Wikipedia:WikiProject Tulips/Review#A-Class review

Optional parameters

• ACR_PASS_CAT – pages using |a class=pass will be categorised into this category. Eg: Successful requests for Tulips A-Class review → Category:Successful requests for Tulips A-Class review
• ACR_FAIL_CAT – pages using |a class=fail will be categorised into this category. Eg: Failed requests for Tulips A-Class review → Category:Failed requests for Tulips A-Class review
• ACR_CURRENT_CAT – pages using |a class=current will be categorised into this category. Eg: Current requests for Tulips A-Class review → Category:Current requests for Tulips A-Class review
• 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.
• ACR_PRELOAD – preload template, to be used when creating a new A-class review discussion page (example).

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:

<syntaxhighlight lang="wikitext"> </syntaxhighlight>

Peer review note

Syntax
<syntaxhighlight lang="wikitext">	peer review=	old peer review=	peer review title=	PR_LINK =	PR_IMAGE =	PR_CAT =	PR_OLD_CAT =	PR_INVALID_CAT = </syntaxhighlight>

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=Wikipedia:WikiProject Tulips/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 Tulips peer review → Category:Requests for Tulips 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.

Other hooks

Template:Deprecated template 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).

Custom masks

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 assesments, and so no assessments will be inherited from other projects.

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.

Examples

<syntaxhighlight lang="wikitext"></syntaxhighlight>

produces:

When inside a banner shell the result is:

<syntaxhighlight lang="wikitext"></syntaxhighlight>

produces:

When inside a banner shell the result is:

See also

• {{WikiProject banner shell}} – template to combine multiple WikiProject Banners
• {{WPBannerDoc}} – convenience template that generates standardised parameter documentation for use on the /doc page
• Wikipedia:WikiProject Council/Guide § Tagging pages with WikiProject banners – guideline about tagging articles for a project

---

require('strict')
local p = {}
local sandbox-- = '/sandbox' -- BE SURE TO COMMENT OUT this definition when deploying to live
local cfg = mw.loadData('Module:WikiProject banner/config' .. (sandbox or ''))
local auxiliary = cfg.auxiliary_module .. (sandbox or '')
local args_module = require('Module:Arguments')
local mbox = require('Module:Message box').main
local yesno = require('Module:Yesno')
local frame = mw.getCurrentFrame()
local lang = mw.getLanguage(cfg.language)
local current_title = mw.title.getCurrentTitle()
local parameter_format = function(parameter, value)
	return frame:expandTemplate{title='para', args={parameter, value or ''}}
end

local wikilink = function(link, display)
	if link then
		return display and '[['..link..'|'..display..']]' or '[['..link..']]'
	else
		return display or ''
	end
end

local display_error = function(text)
	local span = mw.html.create('div')
		:addClass('error')
		:wikitext(text)
	return tostring(span)	
end

local image = function(image_name, size, alt, position)
	return image_name and '[[File:'
		.. image_name
		.. (size and '|' .. size or '')
		.. (position and '|' .. position or '')
		.. (alt and '|alt=' .. alt or '')
		.. ']]'
end

local if_exists = function(target, fallback) -- function to add wikilink if target exists
	local title = mw.title.new(target)
	if title and title.exists then
		return wikilink(target)
	else
		return fallback or target
	end
end

local isarticle = function(class)
	local article = true
	for _,v in ipairs(cfg.quality.non_article_classes) do
		if class==v then -- class matches one of the non-article classes
			article = false
			break
		end
	end
	return article
end

local importance_mask = function(raw_importance, scale, banner_name, pagetype, class)
---------------------------
-- Importance mask --------
---------------------------
local importance
if scale=='inline' then -- pass importance without change
	importance = raw_importance
elseif scale=='subpage' then
	local custom_mask = banner_name:subPageTitle('importance')
	if custom_mask.exists and #custom_mask:getContent()>1 then -- pass to custom importance mask
		importance = mw.text.trim(frame:expandTemplate{
			title = custom_mask.prefixedText,
			args = {
				importance = raw_importance or '¬',
				class = class,
				pagetype = pagetype
			}
		})
	end
elseif raw_importance then-- standard importance scale
	importance = cfg.importance.na
	if pagetype=='article' or pagetype=='set index article' or pagetype=='redirect' or pagetype=='draft' then
		local mask = cfg.importance.mask
		if mask[raw_importance:lower()] then -- valid importance specified
			importance = mask[raw_importance:lower()]
		elseif pagetype=='article' or pagetype=='set index article' then -- unspecified or invalid importance, use "Unknown" for articles
			importance = cfg.importance.unknown
		end
	end
end
return importance
end

---------------------------
-- Quality class mask -----
---------------------------
p.readarticleclass = function(options, page) -- used by _main and also Module:Banner shell
	page = page or current_title.prefixedText
	local get_parameter_value = require('Module:Template parameter value').getParameter
	local success, result = get_parameter_value(page, cfg.banner_shell.redirects, 'class', options)
	return success and result
	-- returns FALSE if banner shell template does not exist on page
	-- returns BLANK if class parameter is not defined or is defined blank
	-- otherwise returns class parameter
end
p.class_mask = function(class, title, FQS, pagetype)
	local resolveFQSgrade = function(class)
		return FQS and lang:ucfirst(class) or 'NA'
	end
	local out
	title = title or mw.title.getCurrentTitle()
	local ns = title.namespace
	class = class:match('^%s*(.-)%s*$'):lower()
	if pagetype=='redirect' or pagetype=='soft redirect' then
		out = resolveFQSgrade('redirect')
	elseif pagetype=='disambiguation page' then
		out = resolveFQSgrade('disambig')
	elseif pagetype=='set index article' then
		out = 'List'
	elseif pagetype=='article' then
		if class=='start' or class=='stub' then -- Ucfirst
			out = lang:ucfirst(class)
		elseif class=='b' or class=='c' or class=='fa' or class=='fl' or class=='a' or class=='ga' then -- Upper-case
			out = class:upper()
		elseif class=='list' or class=='sia' or class=='si' or class=='sl' then-- List
			out = 'List'
		else
			out = '' -- unassessed
		end
	elseif ns==7 or ns==711 then -- File talk
		if class=='fm' then
			out = 'FM'
		else
			out = resolveFQSgrade('file')
		end
	else
	    local grade = cfg.quality.ns_to_class[ns] or 'NA'
		out = resolveFQSgrade(grade)
	end
	return out
end

local page_assessment = function(project, class, importance) -- add PageAssessments parser function
	local assessment = table.concat({project, class or '', importance or ''},'|')
	frame:preprocess('{{#assessment:' .. assessment .. '}}')
end

local bubble = function(text, conflict, style)
	local out = mw.html.create('span')
		:addClass('wpb-header-bubbles')
		:addClass(style)
		:addClass(conflict and 'conflict' or nil)
		:wikitext(text)
	return tostring(out)
end

p._main = function(args, raw_args, demo_page, banner_name, inactive)
---------------------------
-- Initialise parameters --
---------------------------
local project = args.PROJECT or 'PROJECT'
local project_name = args.PROJECT_NAME or 'WikiProject ' .. project
local project_link = mw.title.new(args.PROJECT_LINK or 'Wikipedia:' .. project_name)
local pagetype = demo_page==true and 'article' or require('Module:Pagetype')._main({
	page = demo_page,
	dab = 'disambiguation page',
	sia = 'set index article'
})
local rows, nested_ratings, task_forces, notes, categories, taskforce_categories = {}, {}, {}, {}, {}, {}
local add_category = function(category, key)
	if category and category~='none' then
		table.insert(categories, {category = category, key = key})
	end
end
local parse_pt = function(text) -- function to replace _PAGETYPE_ with the actual page type
	local ptype = pagetype=='set index article' and 'article' or pagetype -- display "article" instead of "set index article"
	return text and text:gsub('_PAGETYPE_', ptype)
end
for arg_name, arg_value in pairs(args) do
	local tf_match = mw.ustring.match(arg_name,'^tf (%d+)$')
	local note_match = mw.ustring.match(arg_name,'^note (%d+)$')
	if tf_match and yesno(arg_value, true) then
		table.insert(task_forces, tf_match)
	elseif note_match and yesno(arg_value, true) then
		table.insert(notes, note_match)
	else
		local tf, cat = mw.ustring.match(arg_name,'^tf (%d+) cat (%d+)$')
		if tf and yesno(arg_value, true) then
			if not taskforce_categories[tf] then -- initialise table
				taskforce_categories[tf] = {}
			end
			table.insert(taskforce_categories[tf], cat)
		end
	end
end
table.sort(task_forces, function (x, y) return tonumber(x) < tonumber(y) end)
table.sort(notes, function (x, y) return tonumber(x) < tonumber(y) end)
---------------------------
-- Location warning -------
---------------------------
local warning = ''
local show_namespace_warning = not (current_title.isTalkPage or demo_page)
if show_namespace_warning then
	local text = cfg.namespace_warning.text:format(
		current_title.talkPageTitle.fullText,
		parameter_format('category', 'no')
	)
	local sortkey = current_title.namespace==10 and cfg.namespace_warning.sortkey_on_template_page or cfg.namespace_warning.sortkey
	if current_title.namespace==10 then -- on the Template namespace
		text = text .. '  ' .. cfg.namespace_warning.on_template_page:format(
			parameter_format('BANNER_NAME'),
			current_title.prefixedText
		)
	end
	warning = mbox('ombox', {
		image = '[[File:' .. cfg.namespace_warning.image .. '|40px]]',
		type = cfg.namespace_warning.type_,
		text = parse_pt(text)
	})
	if not current_title.subjectPageTitle:inNamespace(2) then
		add_category(cfg.namespace_warning.categories, sortkey)
	end
end
---------------------------
-- Substitution warning ---
---------------------------
if args.substcheck=='SUBST' then
	local text = cfg.subst_warning.text:format(
		project_name,
		'<code>&#123;&#123;'..banner_name.prefixedText..'&#125;&#125;</code>'
	)
	warning = warning .. mbox('ombox', {
		image = '[[File:' .. cfg.subst_warning.image .. '|40px]]',
		type = cfg.subst_warning.type_,
		text = text,
	}) .. cfg.subst_warning.categories
end
---------------------------
-- Primary image/text -----
---------------------------
local assessment_cat = args.ASSESSMENT_CAT or project .. ' articles'
local primary_image = function(image_name, size)
	local cell = mw.html.create('td')
	if image_name and image_name~='' then
		cell:addClass('mbox-image wpb-image')
			:wikitext(image(image_name, size, cfg.image.alt))
	else
		cell:addClass('mbox-empty-cell')
	end
	return cell
end
local portal = args.PORTAL
local portal_box = portal and frame:expandTemplate{title='Portal', args={portal}} or ''
local main_text = portal_box .. parse_pt(args.MAIN_TEXT or cfg.main_text:format(
	project_link.prefixedText,
	project_name,
	args.MAIN_ARTICLE and if_exists(args.MAIN_ARTICLE) or if_exists(project, project .. ' articles'),
	project_link.talkPageTitle.prefixedText
))
local image_left_size = args.IMAGE_LEFT_SIZE or cfg.image.default_size
local metadata = function(class, data)
	return mw.html.create('span')
		:addClass(class)
		:wikitext(data)
end
local text_cell = mw.html.create('td')
	:addClass('mbox-text')
	:wikitext(main_text)
	:tag('span')
		:addClass('metadata wpb-metadata')
		:node(metadata('wpb-project', project))
		:node(metadata('wpb-project_link', project_link.prefixedText))
		:node(metadata('wpb-banner_name', banner_name.prefixedText))
		:node(metadata('wpb-assessment_cat', assessment_cat))
	:done()
local primary_row = mw.html.create('tr')
	:node(primary_image(args.IMAGE_LEFT, image_left_size))
	:node(text_cell)
	:node(primary_image(args.IMAGE_RIGHT, args.IMAGE_RIGHT_SIZE or cfg.image.default_size))
table.insert(rows, primary_row)
---------------------------
-- Banner shell checks ----
---------------------------
local title = demo_page and demo_page~=true and mw.title.new(demo_page) or current_title
local article_class = p.readarticleclass({ignore_subtemplates=true}, title.prefixedText)
if article_class then -- banner shell exists
	local special_chars = '([%%%(%)%.%+%-%*%?%[%]%^%$])'
	local banner_name_escaped = banner_name.text
	local page_content = require('Module:Wikitext Parsing').PrepareText(title:getContent()) -- get content of current page
	local content_without_shell
	for capture in mw.ustring.gmatch(page_content, '%b{}') do -- look for possible templates on page
		for _, redirect in ipairs(cfg.banner_shell.redirects) do
			if mw.ustring.find(capture, '^{{%s*' .. redirect .. '%s*[|}].*}}$') then -- found a banner shell
				banner_name_escaped = banner_name_escaped:gsub(special_chars, '%%%1') -- escape each special character
				capture = capture:gsub(special_chars, '%%%1')
				content_without_shell = mw.ustring.gsub(page_content, capture, '') -- remove banner shell content from page content
			end
			if content_without_shell then break end
		end
		if content_without_shell then break end
	end
	local template_outside_shell
	if content_without_shell and mw.ustring.find(content_without_shell, '{{%s*' .. banner_name_escaped .. '%s*[|}]') then -- found banner template outside of the shell
		add_category(cfg.banner_shell.category.outside_shell)
	end
else -- no banner shell on page
	if pagetype=='article' or pagetype=='set index article' then
		add_category(cfg.banner_shell.category.no_banner_shell_articles)
	elseif title.namespace==3 then --User talk namespace
		for _, user in ipairs(cfg.banner_shell.valid_users) do
			if string.find(title.rootText, user) then
				add_category(cfg.banner_shell.category.no_banner_shell)
			end
		end
	elseif title.namespace~=2 then --User namespace
		add_category(cfg.banner_shell.category.no_banner_shell)
	end
end
---------------------------
-- Quality assessment -----
---------------------------
local assessment_link = args.ASSESSMENT_LINK
if not assessment_link then
	local fallback = mw.title.new(project_link.prefixedText .. '/Assessment')
	assessment_link = fallback.exists and fallback.prefixedText
elseif assessment_link=='no' then
	assessment_link = nil
end
local check_exists = function(class, assessment_cat) -- check if category exists and is not blank
	if not isarticle(class) then
		local cat =  mw.title.new('Category:' .. class .. '-Class' .. ' ' .. assessment_cat)
		return (cat.exists and #cat:getContent()>0) and class or 'NA' -- automatically use NA for non-article pages if category does not exist
	else
		return class
	end
end
local class = raw_args.class
if class then -- banner gives quality ratings
	article_class = article_class and p.class_mask(article_class, title, false, pagetype)
	local show_quality, conflict = true, false
	if args.QUALITY_CRITERIA=='custom' then -- project has opted out of standard assessment scale and uses a custom mask
		local custom_mask = banner_name:subPageTitle('class')
		if custom_mask.exists and #custom_mask:getContent()>1 then
			raw_args.demo_page = demo_page -- send demo_page to custom mask
			class = mw.text.trim(frame:expandTemplate{
				title = custom_mask.prefixedText,
				args = raw_args
			})
			if class=='' and article_class and article_class~='' then -- if unassessed and article class exists, check if it can be inherited
				local new_arg_table = {}
				for arg, val in pairs(raw_args) do -- construct new argument table to send to custom mask
					new_arg_table[arg] = val
				end
				new_arg_table.class = article_class -- replace class with inherited class
				local article_class_normalised = mw.text.trim(frame:expandTemplate{
					title = custom_mask.prefixedText,
					args = new_arg_table
				})
				if article_class_normalised and article_class_normalised~='' then
					class = article_class_normalised -- inherit class from article_class normalised by custom mask
				else
					article_class = nil -- effectively no article_class for this banner
				end
			end
		end
	else
		class = p.class_mask(class, title, true, pagetype)
	end
	if article_class then -- banner shell exists
		if class=='' or class==article_class or article_class=='FM' or class=='Disambig' or class=='Redirect' or article_class=='NA' then -- local class matches article class or is blank
			show_quality = false -- hide quality class in project banner
			if article_class~='NA'	then
				class = article_class
			end
			if raw_args.class~='' and args.QUALITY_CRITERIA~='custom' then
				add_category(cfg.banner_shell.category.redundant_class)
			end
		elseif article_class=='' then -- local class defined and no article class defined
			add_category(cfg.banner_shell.category.no_quality_rating)
			if args.QUALITY_CRITERIA~='custom' then
				warning = warning .. display_error(cfg.banner_shell.piqa_warning)
			end
		elseif pagetype~='article' and not isarticle(class) and class~='FM' then -- article class and local class are both non-article classes
			show_quality = false
		elseif args.QUALITY_CRITERIA~='custom' then -- article class exists and differs from local class
			conflict = true
			add_category(class .. cfg.banner_shell.conflict.category)
		end
	end
	if not isarticle(class) then -- check fallbacks for non-article classes
		local category_exists = function(class)
			local cat =  mw.title.new(cfg.quality.assessment_category:format(class, assessment_cat))
			return cat.exists and #cat:getContent()>0 -- check if category exists and is not blank
		end
		if class=='FM' and not category_exists('FM') then
			class = 'File' -- fall back to File-class if FM category does not exist
		end
		if not category_exists(class) then
			class = 'NA' -- automatically use NA for non-article pages if category does not exist
		end
		--if raw_args.class~='' and args.QUALITY_CRITERIA~='custom' then
		--	add_category(cfg.banner_shell.category.redundant_class)
		--end
	end
	local category = (class=='' and 'Unassessed' or class..'-Class') .. ' ' .. assessment_cat
	if show_quality then -- quality rating shown in banner
		local rating
		if pagetype=='article' or pagetype=='set index article' then
			rating = class=='' and cfg.quality.not_yet or cfg.quality.rated:format(class)
		else
			rating = cfg.quality.not_required
		end
		local scale = args.QUALITY_CRITERIA=='custom'
			and assessment_link
			and cfg.quality.project_scale:format(wikilink(assessment_link..'#'..lang:ucfirst(cfg.quality.name), cfg.quality.name))
			or cfg.quality.default_scale
		local quality_rating = conflict
			and cfg.banner_shell.conflict.text
			or cfg.quality.rating:format(rating, scale)
		local cssClass = 'class-' .. (class=='' and 'unassessed' or class:lower())
		local class_row =  mw.html.create('tr')
			:tag('td')
				:addClass('assess')
				:addClass(cssClass)
				:addClass(conflict and 'conflict' or nil)
				:wikitext(wikilink(':Category:' .. category, class=='' and '???' or class))
			:done()
			:tag('td')
				:addClass('mbox-text')
				:attr('colspan', '2')
				:wikitext(parse_pt(quality_rating))
			:done()
		table.insert(rows, class_row)
		table.insert(
			nested_ratings,
			1,
			bubble(class=='' and 'Unassessed' or (class..'‑class'), conflict, cssClass)
		)
	end
	add_category(category)
end
if args.HOOK_ASSESS then
	table.insert(rows, args.HOOK_ASSESS)
end
if raw_args.b1 or raw_args.b2 or raw_args.b3 or raw_args.b4 or raw_args.b5 or raw_args.b6 then
	local b_checklist = require(auxiliary).b_checklist(args, raw_args, class, demo_page, assessment_link)
	table.insert(rows, b_checklist)
end
---------------------------
-- Importance assessment --
---------------------------
local importance = importance_mask(raw_args.importance or raw_args.priority, args.IMPORTANCE_SCALE, banner_name, pagetype, class)
local importance_name = args.IMPN or (raw_args.priority and 'priority' or cfg.importance.default_name)
if importance then -- banner gives importance ratings
	local category = importance .. '-' .. importance_name .. ' ' .. assessment_cat
	if importance~='NA' then -- display importance rating
		local rating = importance=='Unknown' and cfg.importance.not_yet or cfg.importance.rated:format(importance, importance_name)
		local scale_name = cfg.importance.scale:format(importance_name)
		local scale = assessment_link
			and cfg.importance.project_scale:format(assessment_link..'#'..lang:ucfirst(scale_name), scale_name)
			or cfg.importance.default_scale
		local importance_rating = parse_pt(cfg.importance.rating:format(rating, scale))
		local cssClass = 'import-' .. importance:lower()
		local importance_row =  mw.html.create('tr')
			:tag('td')
				:addClass('assess')
				:addClass(cssClass)
				:wikitext(wikilink(':Category:' .. category, importance=='Unknown' and '???' or importance))
			:done()
			:tag('td')
				:addClass('mbox-text')
				:attr('colspan', '2')
				:wikitext(importance_rating)
			:done()
		table.insert(rows, importance_row)
		if importance~='Unknown' then -- importance is not NA or Unknown
			table.insert(
				nested_ratings,
				bubble(importance .. '‑' .. importance_name, false, cssClass)
			)
		end
	end
	add_category(category)
end
page_assessment(project, class, importance)
if args.HOOK_IMPORTANCE then
	table.insert(rows, args.HOOK_IMPORTANCE)
end
if args.QII_FORMAT then
	add_category(require(auxiliary).quality_importance_insection(args, class, importance, importance_name))
end
---------------------------
-- Collapsing sections ----
---------------------------
local collapse_section = function(collapse, new_rows, header)
	if collapse then
		local header_row = mw.html.create('tr')
			:tag('th')
				:attr('colspan','3')
				:addClass('wpb-collapsed-head')
				:wikitext(header)
			:done()
		local blank_row = mw.html.create('tr')
			:tag('td')
				:addClass('mbox-image wpb-gutter')
				:css('min-width', image_left_size)
				:tag('span')
					:addClass('wpb-iefix')
					:wikitext('/&nbsp;')
					:done() --TO FIX IE
			:done()
			:tag('td'):done()
			:tag('td'):done()
		local collapsed_rows = mw.html.create('table')
			:addClass('mw-collapsible mw-collapsed')
			:node(header_row)
			:node(blank_row)
			for _, row in ipairs(new_rows) do
				collapsed_rows:node(row)
			end
		local collapsed_section = mw.html.create('tr')
			:tag('td')
				:attr('colspan','3')
				:addClass('wpb-collapsed-notes')
				:node(collapsed_rows)
			:done()
		table.insert(rows, collapsed_section)
	else
		for _, row in ipairs(new_rows) do
			table.insert(rows, row)
		end
	end
end
---------------------------
-- Task forces ------------
---------------------------
local nested_tf, taskforce_output = {}, {}
local tf_default_size = args.TF_SIZE or cfg.task_force.default_size
for _, k in ipairs(task_forces) do
	local tf_prefix = 'TF_' .. k .. '_'
	local tf_assessment_cat = args[tf_prefix..'ASSESSMENT_CAT'] or (args[tf_prefix..'NAME'] or '')..' articles'
	local tf_importance
	if raw_args['tf '..k..' importance'] then
		tf_importance = importance_mask(raw_args['tf '..k..' importance'], args.IMPORTANCE_SCALE, banner_name, pagetype, class)
		if tf_importance=='Unknown' and yesno(args.INHERIT_IMPORTANCE) then
			tf_importance = importance
		end
	end
	if args[tf_prefix .. 'TEXT']~='none' then
		local portal = args[tf_prefix..'PORTAL'] and frame:expandTemplate{
			title='Portal',
			args={args[tf_prefix .. 'PORTAL'], height='15', margin='0'}
		} or ''
		local text = ''
		local tf_text = args[tf_prefix..'TEXT'] or args.TF_TEXT
		if tf_text then
			text = portal .. tf_text
				:gsub('_NAME_', args[tf_prefix .. 'NAME'] or '')
				:gsub('_LINK_', args[tf_prefix .. 'LINK'] or '')
				:gsub('_IMPORTANCE_', tf_importance or '')
		else
			local tf_importance_text = tf_importance
				and tf_importance~='NA'
				and tf_importance~='Unknown'
				and ' ' .. cfg.task_force.importance:format(
					wikilink(':Category:' .. tf_importance .. '-' .. importance_name .. ' ' .. tf_assessment_cat, tf_importance .. '-' .. importance_name)
				) or ''
			text = portal .. cfg.task_force.text:format(
				wikilink(args[tf_prefix .. 'LINK'], args[tf_prefix .. 'NAME']),
				tf_importance_text
			)
		end
		local tf_size = args[tf_prefix .. 'SIZE'] or tf_default_size
		local tf_image = ''
		if args[tf_prefix .. 'IMAGE'] then
			tf_image = image(args[tf_prefix .. 'IMAGE'], tf_size, cfg.task_force.icon_alt, 'center')
		end
		local taskforce = mw.html.create('tr')
			:tag('td')
				:wikitext(tf_image)
			:done()
			:tag('td')
				:addClass('mbox-text')
				:attr('colspan','2')
				:wikitext(parse_pt(text))
			:done()
		table.insert(taskforce_output, taskforce)
	end
	if args[tf_prefix..'HOOK'] then
		table.insert(taskforce_output, args[tf_prefix..'HOOK'])
	end
	if yesno(args[tf_prefix..'QUALITY']) and class then
		local tf_class = check_exists(class, tf_assessment_cat)
		add_category((tf_class=='' and 'Unassessed' or tf_class..'-Class') .. ' ' .. tf_assessment_cat)
	end
	if tf_importance then
		add_category(tf_importance .. '-' .. importance_name .. ' ' .. tf_assessment_cat)
	end
	if args[tf_prefix..'QII_FORMAT'] then
		add_category(require(auxiliary).quality_importance_insection(args, class, tf_importance, importance_name, tf_prefix))
	end
	if args[tf_prefix..'NAME'] then
		page_assessment(project..'/'..args[tf_prefix..'NAME'], class, tf_importance)
	end
	if args[tf_prefix..'MAIN_CAT'] then
		add_category(args[tf_prefix..'MAIN_CAT'])
	end
	if args[tf_prefix..'NESTED'] then
		table.insert(nested_tf, wikilink(args[tf_prefix..'LINK'], args[tf_prefix..'NESTED']))
	end
	for _, c in ipairs(taskforce_categories[k] or {}) do-- add additional taskforce categories
		add_category(args[tf_prefix..'CAT_'..c])
	end
end
if args.HOOK_TF then
	table.insert(taskforce_output, args.HOOK_TF)
end
local threshold = tonumber(args.TF_COLLAPSE) or (args.TF_HEADER and cfg.task_force.lower_threshold) or cfg.task_force.upper_threshold
collapse_section(
	#taskforce_output > threshold,
	taskforce_output,
	args.TF_HEADER or cfg.task_force.header
)
---------------------------
-- Notes ------------------
---------------------------
local note_output = {}
local note_default_size = args.NOTE_SIZE or args.NOTE_1_SIZE or cfg.note.default_size
local render_note = function(note_args)--text, image_name, size, category, sort_prefix
	local sort = note_args.sort_prefix and note_args.sort_prefix .. current_title.text
	add_category(note_args.category, sort)
	add_category(note_args.category2, sort)
	if note_args.text then
		local note_image = image(
			note_args.image_name,
			note_args.size or note_default_size,
			cfg.note.icon_alt,
			'center'
		)
		local new_note = mw.html.create('tr')
			:tag('td')
				:css('background', note_args.background)
				:wikitext(note_image)
			:done()
			:tag('td')
				:addClass('mbox-text')
				:attr('colspan', '2')
				:wikitext(parse_pt(note_args.text))
			:done()
		table.insert(note_output, new_note)
		if note_image then
			local icon = mw.html.create('span')
				:addClass('wpb-header-bubbles')
				:wikitext('[[File:' .. note_args.image_name .. '|' .. cfg.note.header_icon .. '|' .. parse_pt(note_args.text) .. '|link=|alt=]]')
			table.insert(nested_ratings, tostring(icon))
		end
	end
end
local auto = false
local auto_arg = args.auto and args.auto:lower()
if (auto_arg=='yes' or auto_arg=='stub') and class=='Stub' then
	auto = 'stub'
elseif (auto_arg=='inherit' or auto_arg=='length') and class and class~='' then
	auto = auto_arg
end
if auto then
	local auto_cat = args.AUTO_ASSESS_CAT or cfg.auto.default_cat:format(project)
	local auto_text = cfg.auto.assessed:format(
		cfg.auto[auto], -- method of automatic assessment
		parameter_format('auto')
	)
	local sort_prefix
	if auto=='stub' then
		sort_prefix = 'S'
	elseif auto=='length' then
		sort_prefix = 'L'
	elseif auto=='inherit' then
		local sort_codes = cfg.auto.sort_codes
		sort_prefix = sort_codes[class] or cfg.auto.default_sort_code
	end
	render_note{
		text = auto_text,
		image_name =  cfg.auto.icon,
		category = auto_cat,
		sort_prefix = sort_prefix
	}
end
if yesno(args.attention, true) then
	local attention_cat = args.ATTENTION_CAT or cfg.attention.default_cat:format(project)
	render_note{
		text = cfg.attention.text,
		image_name = cfg.attention.icon,
		category = attention_cat
	}
end
if yesno(args.infobox, true) then
	local infobox_cat = args.INFOBOX_CAT or cfg.infobox.default_cat:format(project)
	render_note{
		text = cfg.infobox.text,
		image_name = cfg.infobox.icon,
		category = infobox_cat
	}
end
for _, k in ipairs(notes) do
	local note_prefix = 'NOTE_' .. k .. '_'
	render_note{
		text = parse_pt(args[note_prefix..'TEXT']),
		image_name = args[note_prefix..'IMAGE'],
		size = args[note_prefix..'SIZE'],
		category = args[note_prefix..'CAT']
	}
end
if yesno(args['image-needed'], true) then
	local image_needed_args = require(auxiliary).image_needed(args)
	render_note(image_needed_args)
end
if yesno(args['collaboration-candidate'], true) or yesno(args['collaboration-current'], true) or yesno(args['collaboration-past'], true) then
	local collaboration_args = require(auxiliary).collaboration(args, current_title)
	render_note(collaboration_args.candidate)
	render_note(collaboration_args.current)
	render_note(collaboration_args.past)
end
if yesno(args['a class'], true) then
	local a_class_args = require(auxiliary).a_class(args, lang)
	render_note(a_class_args)
end
if yesno(args['peer review'], true) or yesno(args['old peer review'], true) then
	local peer_review_args = require(auxiliary).peer_review(args, current_title)
	render_note(peer_review_args.current)
	render_note(peer_review_args.past)
end

local note_count = #note_output
if args.HOOK_NOTE then
	table.insert(note_output, args.HOOK_NOTE)
	local hook_collapsed = 0
	if args.HOOK_COLLAPSED then
		local success, result = pcall(mw.ext.ParserFunctions.expr, args.HOOK_COLLAPSED)
		hook_collapsed = success and tonumber(result) or 0
		if args.HOOK_COLLAPSED=='auto' then
			hook_collapsed = 1
		end
	end
	note_count = note_count + hook_collapsed
end
collapse_section(
	note_count > (tonumber(args.COLLAPSED) or cfg.note.threshold),
	note_output,
	args.COLLAPSED_HEAD or cfg.note.header
)
---------------------------
-- Bottom text ------------
---------------------------
if args.HOOK_BOTTOM then
	table.insert(rows, args.HOOK_BOTTOM)
end
if args.TODO_LINK or args.TODO_TEXT then
	local todolist = require(auxiliary).todo_list(args, frame)
	table.insert(rows, todolist)
end
if args.BOTTOM_TEXT then
	local bottom_text = mw.html.create('tr')
		:tag('td')
			:attr('colspan','3')
			:wikitext(parse_pt(args.BOTTOM_TEXT))
		:done()
	table.insert(rows, bottom_text)
end
if args.MAIN_CAT then
	add_category(args.MAIN_CAT)
end
---------------------------
-- Nested display ---------
---------------------------
if args.HOOK_NESTED then
	local hook_nested = args.HOOK_NESTED:gsub('^&#32;/ ', '') -- remove initial slash, will be added later
	table.insert(nested_tf, hook_nested)
end
local nested_tf_str = ''
if #nested_tf>0 then
	nested_tf_str = tostring(mw.html.create('span')
		:addClass('wpb-nested-task-force')
		:wikitext(': ' .. table.concat(nested_tf, ' / '))
	)
end
local nested_ratings_str = #nested_ratings>0 and table.concat(nested_ratings, ' ') or ''
if args.HOOK_NESTED_ASSESS then
	nested_ratings_str = nested_ratings_str .. tostring(mw.html.create('span')
		:addClass('wpb-header-bubbles')
		:wikitext(args.HOOK_NESTED_ASSESS)
	)
end
local header_row = mw.html.create('tr')
	:addClass('wpb-header')
	:tag('td')
		:addClass('wpb-header-icon')
		:wikitext(image(args.IMAGE_LEFT, cfg.image.header_size, cfg.image.alt))
		:done()
	:tag('td')
		:addClass('wpb-header-combined')
		:wikitext(wikilink(project_link.prefixedText, project) .. nested_tf_str .. '  ' .. nested_ratings_str)
		:done()
---------------------------
-- Default sort -----------
---------------------------
if args.listas then
	frame:preprocess('{{DEFAULTSORT:' .. args.listas .. '}}')
	if title.namespace~=3 then -- exclude user talk namespace
		local success, shell_listas_value = require('Module:Template parameter value').getParameter(
			title.prefixedText,
			cfg.banner_shell.redirects,
			'listas',
			{ignore_subtemplates = true, ignore_blank = true}
		)
		if success and shell_listas_value~='' then
			if args.listas==shell_listas_value then -- same value in both (with spacing trimming)
				add_category(cfg.banner_shell.category.redundant_listas)
			end
		else -- listas is blank or not defined in banner shell
			add_category(cfg.banner_shell.category.move_listas)
		end
	end
end
---------------------------
-- Prepare categories -----
---------------------------
local categories_formatted = ''
if demo_page and demo_page~=true then -- for testing purposes
	local category_list = mw.html.create('ul')
	for _, cat in ipairs(categories) do
		local item = mw.html.create('li')
			:wikitext(wikilink(':Category:' .. cat.category, cat.category))
		category_list:node(item)
	end
	local category_box = mw.html.create('div')
		:addClass('wpb-category-box')
		:wikitext('Categories:')
		:node(category_list)
	categories_formatted = tostring(category_box)
elseif not demo_page then
	local categories_linked = {}
	for _, cat in ipairs(categories) do
		local cat_link = wikilink('Category:' .. cat.category, cat.key)
		table.insert(categories_linked, cat_link)
	end
	categories_formatted = table.concat(categories_linked)
end
---------------------------
-- Make banner ------------
---------------------------
local banner_rows = mw.html.create('table')
for _, row in ipairs(rows) do
	banner_rows:node(row)
end
local banner = mw.html.create('table')
	:addClass('tmbox tmbox-notice mw-collapsible innercollapse wpb wpb-table')
	:addClass(inactive and cfg.inactive.class or nil)
	:node(header_row)
	:tag('tr')
		:tag('td')
			:addClass('mbox-text wpb-main')
			:attr('colspan','2')
			:node(banner_rows)
	:allDone()
local tstyle = frame:extensionTag('templatestyles', '', {src='Module:Message box/tmbox.css'}) ..
	frame:extensionTag ('templatestyles', '', {src = 'Module:WikiProject banner' .. (sandbox or '') .. '/styles.css'})
return warning .. tstyle .. tostring(banner) .. categories_formatted, note_count, #taskforce_output, assessment_link
end

local initialise = function(args, raw_args, inactive_status)
---------------------------
-- Initialise arguments ---
---------------------------
local parent_args = args_module.getArgs(frame, {parentOnly = true})
local category = parent_args.category or args.category or true
local demo_page = parent_args.demo_page
local on_template_page = false
local banner_name = mw.title.new(args.BANNER_NAME or 'Template:WikiProject ' .. (args.PROJECT or 'PROJECT'))
if not demo_page then
	if yesno(category, true) then
		on_template_page = current_title.rootPageTitle==banner_name.rootPageTitle
	else
		demo_page = true
	end
end
local project_name = args.PROJECT_NAME or 'WikiProject ' .. (args.PROJECT or 'PROJECT')
local unknown_parameters = ''
if banner_name.exists and not demo_page then -- check for unknown parameters
	local parameters = {}
	for parameter in banner_name:getContent():gmatch('{{{([^|}]+)') do
		table.insert(parameters, parameter)
	end
	local check_for_unknown = require('Module:Check for unknown parameters')._check
	local unknowns = check_for_unknown(parameters, parent_args)
	if unknowns and unknowns~='' then-- there are some unknown parameters
		parameters.preview = cfg.unknown_parameters.preview:format(wikilink(banner_name.fullText))
		local unknown_category = cfg.unknown_parameters.tracking:format(project_name)
		if not mw.title.new(unknown_category).exists then
			unknown_category = cfg.unknown_parameters.default
		end
		parameters.unknown = unknown_category and '[[' .. unknown_category .. '|_VALUE_]]' or ''
		unknown_parameters = check_for_unknown(parameters, parent_args)
	end
end
if on_template_page then
	local templatepage = require('Module:WikiProject banner/templatepage' .. (sandbox or '')).templatepage
	return templatepage(args, raw_args, inactive_status)
else
	return unknown_parameters
		.. p._main(args, raw_args, demo_page, banner_name, inactive_status and true or false), nil -- nil to disregard subsequent returned values
end
end

p.main = function(frame)
	local args = args_module.getArgs(frame, {frameOnly = true})
	local raw_args = args_module.getArgs(frame, {frameOnly = true, removeBlanks = false})
	return initialise(args, raw_args)
end
---------------------------
-- Inactive projects ------
---------------------------
p.inactive = function(frame)
	local args = args_module.getArgs(frame, {frameOnly = true})
	local project_name = args.PROJECT_NAME or 'WikiProject ' .. (args.PROJECT or 'PROJECT')
	local project_link = mw.title.new(args.PROJECT_LINK or 'Wikipedia:' .. project_name)
	local _status = cfg.inactive.status[args.PROJECT_STATUS] or cfg.inactive.default
	local main_text = cfg.inactive.text:format(
		project_link.prefixedText,
		project_name,
		_status
	)
	return initialise(
		{
			PROJECT = args.PROJECT,
			BANNER_NAME = args.BANNER_NAME,
			IMAGE_LEFT = cfg.inactive.image,
			IMAGE_LEFT_SIZE = cfg.inactive.image_size,
			MAIN_TEXT = main_text,
			HOOK_NESTED_ASSESS = ' ' .. cfg.inactive.nested:format(_status),
			substcheck = args.substcheck,
			category = args.category
		}, {
			substcheck = '' -- to prevent warning on templatepage
		}, _status
	)
end

return p