Module:WikiProject banner: Difference between revisions
Content deleted Content added
make that an empty table instead |
I have 0 expectation this will work |
||
| Line 5: | Line 5: | ||
require ('Module:No globals') |
require ('Module:No globals') |
||
local getArgs = require ('Module:Arguments').getArgs |
|||
local p = {} |
local p = {} |
||
local cfg = { |
|||
["subst_warning"] = { |
|||
["image"] = '[[File:Stop hand nuvola.svg|40px]]', |
|||
["type"] = 'content', |
|||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
}, |
|||
["namespace_warning"] = { |
|||
["image"] = '[[File:Stop hand nuvola.svg|40px]]', |
|||
["type"] = 'content', |
|||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
} |
|||
} |
|||
-- Make it cleaner to initialize 'trivial' variables. |
-- Make it cleaner to initialize 'trivial' variables. |
||
| Line 30: | Line 62: | ||
local warning = require('Module:Message box').main( 'tmbox', { |
local warning = require('Module:Message box').main( 'tmbox', { |
||
image = |
image = cfg.subst_warning.image, |
||
type = |
type = cfg.subst_warning.type, |
||
text = string.format(cfg.subst_warning.text, project, target_name) |
|||
| ⚫ | |||
| ⚫ | |||
project .. |
|||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
target_name .. |
|||
| ⚫ | |||
}) |
}) |
||
| Line 48: | Line 73: | ||
-- Is the intent of <includeonly> only to add it to the banner invocation |
-- Is the intent of <includeonly> only to add it to the banner invocation |
||
-- and not elsewhere? TODO: Check docs. |
-- and not elsewhere? TODO: Check docs. |
||
categories = cfg.subst_warning.categories |
|||
| ⚫ | |||
| ⚫ | |||
end |
end |
||
| Line 76: | Line 100: | ||
local on_template_page |
local on_template_page |
||
if current_namespace == 'Template' then |
if current_namespace == 'Template' then |
||
| ⚫ | |||
| ⚫ | |||
cfg.namespace_warning.on_template_page, |
|||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
) |
|||
| ⚫ | |||
| ⚫ | |||
'</kbd>.' |
|||
else |
else |
||
on_template_page = '' |
on_template_page = '' |
||
| Line 88: | Line 110: | ||
local warning = require('Module:Message box').main( 'tmbox', { |
local warning = require('Module:Message box').main( 'tmbox', { |
||
image = |
image = cfg.namespace_warning.image, |
||
type = |
type = cfg.namespace_warning.type, |
||
text = string.format( |
|||
| ⚫ | |||
cfg.namespace_warning.text, |
|||
require('Module:Pagetype')._main({}) |
require('Module:Pagetype')._main({}), -- empty args table for pagetype |
||
'\'s <b>[[' .. |
|||
current_title.talkPageTitle.fullText |
current_title.talkPageTitle.fullText, |
||
| ⚫ | |||
| ⚫ | |||
on_template_page |
|||
| ⚫ | |||
) |
|||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
}) |
}) |
||
| Line 116: | Line 132: | ||
end |
end |
||
category = string.format( |
|||
| ⚫ | |||
cfg.namespace_warning.categories, |
|||
sortkey |
sortkey |
||
| ⚫ | |||
) |
|||
end |
end |
||
| Line 158: | Line 175: | ||
function p.main(frame) |
function p.main(frame) |
||
local args = getArgs(frame) |
local args = require ('Module:Arguments').getArgs(frame) |
||
return p._main(args, frame) |
return p._main(args, frame) |
||
end |
end |
||
Revision as of 20:45, 9 November 2020
 | This module is rated as ready for general use. It has reached a mature form and is thought to be relatively bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing. |
 | This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
| WikiProject banners |
|---|
 | This Lua module is used on approximately 11,300,000 pages, or roughly 18% of all pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
 | This module uses TemplateStyles: |
 | This module depends on the following other modules:
|
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. 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 parameterfoo, you need to include the codefoo={{{foo|}}}.
Parameters
| 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
PROJECT(Required) – the name of the project without the word "WikiProject", used in a variety of contexts; first letter should usually be capitalised. Eg:TulipsBANNER_NAME={{subst:FULLPAGENAME}}"Template:WikiProject <PROJECT>". If this is not the case then define the page name in this parameter. Eg:Template:Tulips projectPROJECT_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 TulipsPROJECT_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.jpgIMAGE_LEFT_SIZE– the size ofIMAGE_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.jpgIMAGE_RIGHT_SIZE– the size ofIMAGE_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 isPROJECT; 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:TulipsMAIN_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 articlesBOTTOM_TEXT– if defined, contains text that will appear across the bottom of the banner and above the collapsed section (if one is present).
Example
{{#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:
Lua error in package.lua at line 80: module 'Module:No globals' not found.
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|}}}autothe 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 assessedPROJECTarticles. 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-ClassASSESSMENT_CAT. Eg:|ASSESSMENT_CAT=Liliaceae articles→ Category:FA-Class Liliaceae articles
Example
{{#invoke:WikiProject banner|main
|PROJECT = Tulips
|substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
|listas={{{listas|}}}
|IMAGE_LEFT = Tulipa suaveolens floriade to Canberra.jpg
|QUALITY_SCALE = extended
|class={{{class|}}}
|auto={{{auto|}}}
|importance={{{importance|}}}
|ASSESSMENT_LINK = Wikipedia:WikiProject Tulips/Article grading
}}
|
- Produces:
Lua error in package.lua at line 80: module 'Module:No globals' not found.
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=yeson 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:PROJECTarticles needing attention. Eg:Floridiae taskforce articles needing attention→ Category:Floridiae taskforce articles needing attention. A value ofnoneresults 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=yeson 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:PROJECTarticles needing infoboxes. Eg:Floridiae taskforce articles needing infoboxes→ Category:Floridiae taskforce articles needing infoboxes. A value ofnoneresults in no categorisation.
note 1– pass this parameter through to trigger any defined note. Eg:note 1={{{needs-photo|}}}, then by including|needs-photo=yeson 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.svgNOTE_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=0will always create a collapse box (if there are any notes to fill it), while|COLLAPSED=999will never trigger a collapse box. Eg:6COLLAPSED_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 = Tulips
|substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
|listas={{{listas|}}}
|IMAGE_LEFT = Tulipa suaveolens floriade to Canberra.jpg
|QUALITY_SCALE = extended
|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:
Lua error in package.lua at line 80: module 'Module:No globals' not found.
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/FloridiaeTF_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 forceTF_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:FloridiaeTF_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.jpgTF_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:yestf 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 articlesTF_1_MAIN_CAT– if defined, all pages displaying "tf 1" will be categorised into Category:TF_1_MAIN_CAT. Eg:Floridiae articles→ Category:Floridiae articlesTF_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
{{#invoke:WikiProject banner|main
|PROJECT = Tulips
|substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
|listas={{{listas|}}}
|IMAGE_LEFT = Tulipa suaveolens floriade to Canberra.jpg
|QUALITY_SCALE = standard
|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:
Lua error in package.lua at line 80: module 'Module:No globals' not found.
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 "N " is the number of the task force, and the project and task force names are included where indicated.
Advanced features
 | 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.
| Syntax |
|---|
{{#invoke:WikiProject banner|main
...
|b1={{{b1|}}}
|b2={{{b2|}}}
|b3={{{b3|}}}
|b4={{{b4|}}}
|b5={{{b5|}}}
|b6={{{b6|}}}
}}
|
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_CATtoB6_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=3then 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 |
|---|
|TODO_LINK =
|TODO_TEXT =
|TODO_TITLE =
|TODO_EDITLINKS =
|
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.
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
{{#invoke:WikiProject banner|main
|PROJECT = Tulips
|listas={{{listas|}}}
|NAME = The Tulip taskforce
|IMAGE_LEFT = Tulipa suaveolens floriade to Canberra.jpg
|TODO_LINK = Template:To do/to do
|TODO_TITLE = WikiProject Tulips To-do
}}
|
- Produces:
Lua error in package.lua at line 80: module 'Module:No globals' not found.
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. TheC,IandTare replaced by the class, importance and topic respectively. For example:I C T, e.g. Category:Mid-importance B-Class Geology articlesC T of I, e.g. Category:C-Class Andhra Pradesh articles of Low-importanceC I T, e.g. Category:B-Class High-importance Pornography articlesC, 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=NAQII_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 |
|---|
|image-needed={{{needs-image|}}}
|IM_IMAGE =
|image-details={{{details|}}}
|image-location={{{location|}}}
|IM_LOCATION_CATEGORY =
|image-topic={{{topic|}}}
|IM_TOPIC_CATEGORY =
|image-type={{{type|}}}
|
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 |
|---|
|collaboration-candidate={{{**PARAMETER**|}}}
|collaboration-current={{{**PARAMETER**|}}}
|collaboration-past={{{**PARAMETER**|}}}
|COLL_LINK =
|COLL_TEXT =
|COLL_IMAGE =
|COLL_CANDIDATE_CAT =
|COLL_CURRENT_CAT =
|COLL_PAST_CAT =
|
This feature 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 MonthCOLL_IMAGE– the name of the image to use. If not specified then
is used.COLL_CANDIDATE_CAT– if defined, pages using|candidate=yeswill be categorised into this category, e.g.|COLL_CANDIDATE_CAT=Paranormal collaboration candidates→ Category:Paranormal collaboration candidatesCOLL_CURRENT_CAT– if defined, pages using|current=yeswill be categorised into this category, e.g.|COLL_CURRENT_CAT=Paranormal collaborations→ Category:Paranormal collaborationsCOLL_PAST_CAT– if defined, pages using|past=yeswill be categorised into this category, e.g.|COLL_PAST_CAT=Past paranormal collaborations→ Category:Past paranormal collaborations
A-class review note
| Syntax |
|---|
|a class={{{**PARAMETER**|}}}
|ACR_SUBPAGE_LINK =
|ACR_REVIEW_LINK =
|ACR_PASS_CAT =
|ACR_FAIL_CAT =
|ACR_CURRENT_CAT =
|ACR_PRELOAD =
|
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=passwill be categorised into this category. Eg:Successful requests for Tulips A-Class review→ Category:Successful requests for Tulips A-Class reviewACR_FAIL_CAT– pages using|a class=failwill be categorised into this category. Eg:Failed requests for Tulips A-Class review→ Category:Failed requests for Tulips A-Class reviewACR_CURRENT_CAT– pages using|a class=currentwill be categorised into this category. Eg:Current requests for Tulips A-Class review→ Category:Current requests for Tulips A-Class reviewACR_IMAGE– a custom image can be set, using the same syntax as for other note images. Eg:Exquisite-kfind.pngACR_SIZE– a custom image size can be set, using the usual note syntax. Eg:20x20pxACR_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:
{{#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
}}
|
Peer review note
| Syntax |
|---|
|peer review={{{**PARAMETER**|}}}
|old peer review={{{**PARAMETER**|}}}
|peer review title={{{**PARAMETER**|}}}
|PR_LINK =
|PR_IMAGE =
|PR_CAT =
|PR_OLD_CAT =
|PR_INVALID_CAT =
|
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=yeswill be categorised into this category, e.g.|PR_CAT=Requests for Tulips peer review→ Category:Requests for Tulips peer reviewPR_OLD_CAT– if defined, pages using|old peer review=yeswill 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.
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 assessments, 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
{{#invoke:WikiProject banner|inactive
|PROJECT = Extreme sports
}}
- produces:
Lua error in package.lua at line 80: module 'Module:No globals' not found.
- When inside a banner shell the result is:
Lua error in package.lua at line 80: module 'Module:No globals' not found.
{{#invoke:WikiProject banner|inactive
|PROJECT = Policy and Guidelines
|PROJECT_STATUS = defunct
}}
- produces:
Lua error in package.lua at line 80: module 'Module:No globals' not found.
- When inside a banner shell the result is:
Lua error in package.lua at line 80: module 'Module:No globals' not found.
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
 WikiProject guides | |
|---|---|
 Directories and summaries | |
 Culture and the arts | |
 Geographical | |
 History and society | |
 Science, technologyand engineering | |
 Wikipedia assistanceand tasks | |
| Main namespace | |
|---|---|
| Other namespaces | |
| All namespaces | |
| Navboxes with templates |
|
| Inline images | |
| Help pages | |
| Related topics | |
| Search | |
--[[
This implements {{WPBannerMeta}}
]]
require ('Module:No globals')
local p = {}
local cfg = {
["subst_warning"] = {
["image"] = '[[File:Stop hand nuvola.svg|40px]]',
["type"] = 'content',
-- Lua 5.2 gives us access to \z. Pipe dream upgrade.
["text"] = '<p>It seems that the <i>WikiProject %s</i> banner has ' ..
'been [[Wikipedia:Substitution|substituted]] on this page ' ..
'instead of being [[Wikipedia:Transclusion|transcluded]]. ' ..
'Please undo the edit and type <code>{{%s}}' ..
'</code> instead.</p>',
["categories"] = '<includeonly>[[Category:WikiProject banners with formatting errors|SUBST]]' ..
'[[Category:Pages with incorrectly substituted templates]]</includeonly>'
},
["namespace_warning"] = {
["image"] = '[[File:Stop hand nuvola.svg|40px]]',
["type"] = 'content',
-- Lua 5.2 gives us access to \z. Pipe dream upgrade.
["text"] = '<p>The WikiProject banner below should be moved to this ' ..
'%s\'s <b>[[%s|talk page]]</b>.</p><p style="font-size:95%%">If ' ..
'this is a demonstration of the template, please set the ' ..
'parameter %s to prevent this page being miscategorised. %s</p>' ..
'<b>Note:</b> When merging or renaming banners, categories, ' ..
'projects or taskforces, you may need to update ' ..
'[[WP:AALERTS/LIST]] for [[WP:AALERTS|Article Alerts]] to work ' ..
'correctly (ask for help at [[WT:AALERTS]]).',
["on_template_page"] = 'If this message appears on the template ' ..
'page itself, please check that the value of the %s parameter ' ..
'is correctly set to <kbd>%s</kbd>.',
["categories"] = '<includeonly>[[Category:WikiProject banners with ' ..
'formatting errors|%s]]</includeonly>'
}
}
-- Make it cleaner to initialize 'trivial' variables.
local function arg_or_default(args, from_arg, default)
if args[from_arg] and args[from_arg] ~= '' then
return args[from_arg]
else
return default
end
end
local function warn_on_subst(subst, project, banner_name, frame, suppress_categories)
if subst ~= 'SUBST' then
return ''
end
local target_name
if banner_name then
target_name = mw.title.new( banner_name ).text
else
target_name = 'WikiProject ' .. project
end
local warning = require('Module:Message box').main( 'tmbox', {
image = cfg.subst_warning.image,
type = cfg.subst_warning.type,
text = string.format(cfg.subst_warning.text, project, target_name)
})
local categories
if suppress_categories then
categories = ''
else
-- Is the intent of <includeonly> only to add it to the banner invocation
-- and not elsewhere? TODO: Check docs.
categories = cfg.subst_warning.categories
end
return warning .. categories
end
local function warn_on_namespace(args, frame, suppress_categories)
local current_title = mw.title.getCurrentTitle()
local current_namespace = current_title.nsText
-- I don't really understand why this is the guard...
-- TODO: More i18n to compare the namespace number...
if current_namespace == 'User' then
return ''
end
local para_category = frame:expandTemplate{
title = 'para',
args = {'category', 'no'}
}
local para_banner_name = frame:expandTemplate{
title = 'para',
args = {'BANNER_NAME'}
}
local on_template_page
if current_namespace == 'Template' then
on_template_page = string.format(
cfg.namespace_warning.on_template_page,
para_banner_name,
current_title.rootText
)
else
on_template_page = ''
end
local warning = require('Module:Message box').main( 'tmbox', {
image = cfg.namespace_warning.image,
type = cfg.namespace_warning.type,
text = string.format(
cfg.namespace_warning.text,
require('Module:Pagetype')._main({}), -- empty args table for pagetype
current_title.talkPageTitle.fullText,
para_category,
on_template_page
)
})
local category
if suppress_categories then
category = ''
else
local sortkey
if current_namespace == 'Template' then
sortkey = "PARAMETER"
else
sortkey = "LOCATION"
end
category = string.format(
cfg.namespace_warning.categories,
sortkey
)
end
return warning .. category
end
function p._main(args, frame)
-- Initialize sufficient stuff to do warnings.
local subst = arg_or_default(args, 'substcheck', '¬')
local project = arg_or_default(args, 'PROJECT', nil)
if not project then error('PROJECT must be defined') end
local banner_name = arg_or_default(args, 'BANNER_NAME', nil)
-- TODO: When done, remove suppress_categories (or convert).
local category = arg_or_default(args, 'category', '¬')
local suppress_categories = arg_or_default(args, 'suppress', nil)
local subst_warning = warn_on_subst(subst, project, banner_name, frame,
suppress_categories)
local namespace_warning = warn_on_namespace(args, frame, suppress_categories)
local project_link = arg_or_default(args, 'PROJECT_LINK', nil)
local builder = mw.html.create('table')
builder:addClass('tmbox'):addClass('tmbox-notice'):addClass('mw-collapsible')
:addClass('innercollapse'):addClass('wpb')
:css('height', '0')
:attr('role', 'presentation')
:tag('tr'):addClass('wpb-header')
:tag('td')
:cssText('text-align: right; padding: 0.3em 1em 0.3em 0.3em;'
.. 'width: 50%; font-weight: bold;')
return subst_warning ..
namespace_warning ..
tostring(builder)
end
function p.main(frame)
local args = require ('Module:Arguments').getArgs(frame)
return p._main(args, frame)
end
return p