View source for Module:WikiProject banner/auxiliary/doc

{{Module rating|beta}}
{{high-use}}
{{WikiProject banner related}}
{{Lua|Module:WikiProject banner/config|Module:Yesno}}
{{warning|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.}}
This module contains extra functions not frequently used by [[Module:WikiProject banner]].

=== B-class checklist ===
Enables a B-class checklist. There are [[WP:BCLASS|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.
{|class="wikitable mw-collapsible" style="float: right; width: 40%;"
!Syntax
|-
|<syntaxhighlight lang="wikitext">
{{#invoke:WikiProject banner|main
...

 |b1={{{b1|}}}
 |b2={{{b2|}}}
 |b3={{{b3|}}}
 |b4={{{b4|}}}
 |b5={{{b5|}}}
 |b6={{{b6|}}}
}}
</syntaxhighlight>
|}

==== Required parameters ====
*The six B-Class criteria: <code>'''b1'''</code>, <code>'''b2'''</code>, <code>'''b3'''</code>, <code>'''b4'''</code>, <code>'''b5'''</code>, <code>'''b6'''</code>

==== Optional parameters ====
*<code>'''B_DISPLAY_ON_START'''</code> &ndash; 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.
*<code>'''B_MAIN_CAT'''</code> &ndash; specifies a category to use when any of the checklist parameters are blank.
*<code>'''B1_CAT'''</code> to <code>'''B6_CAT'''</code> &ndash; 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:
<pre>b1={{{B-Class-1|{{{b1|}}}}}}</pre>

If only the standard parameters are used, then {{nowrap|''eg: '''<code><nowiki>b1={{{b1|}}}</nowiki></code>'''''}}, 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 {{#invoke:Data|Module:WikiProject banner/config|task_force|upper_threshold}} task forces. You can configure this behaviour with the following parameters:
* <code>'''TF_COLLAPSE'''</code> &ndash; the threshold number of task forces for them to collapse, e.g. if {{para|TF_COLLAPSE|3}} then they will collapse whenever there are more than 3 task forces.
* <code>'''TF_HEADER'''</code> &ndash; the heading for the collapsed section. The default is '''{{#invoke:Data|Module:WikiProject banner/config|task_force|header}}'''

=== To-do list ===
This enables a project to-do list or other similar list to be integrated into a project banner.
{|class="wikitable mw-collapsible" style="float: right; width: 40%;"
!Syntax
|-
|<syntaxhighlight lang="wikitext" style="font-size:90%">
|TODO_LINK        = 
|TODO_TEXT        = 
 |TODO_TITLE      = 
 |TODO_EDITLINKS  = 
</syntaxhighlight>
|}
There are two main parameters, {{para|TODO_LINK}} and {{para|TODO_TEXT}}. Only one should be used at any time. If the to-do list is located on a different page then <code>TODO_LINK</code> should be used. However, if you've just got some text to include then you can use the <code>TODO_TEXT</code> option instead.

If you are using {{para|TODO_LINK}} and don't want to see the edit links at the top of the textbox, set <code>TODO_EDITLINKS=no</code>.

====Example====
{|style="background: none; width: 50%;"
|<syntaxhighlight lang="wikitext">
{{#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
}}</syntaxhighlight>
|}
:Produces:
{{#invoke:WikiProject banner|main
|PROJECT          = Tulips
 |category=no
 |listas={{{listas|}}}
|NAME             = The Tulip taskforce
|IMAGE_LEFT       = Tulipa suaveolens floriade to Canberra.jpg
|IMAGE_LEFT_LARGE = 50px
|TODO_LINK        = Template:To do/to do
 |TODO_TITLE      = WikiProject Tulips To-do
}}

=== 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 ====
* <code>'''QII_FORMAT'''</code> &ndash; the format of the category names. The <code>C</code>, <code>I</code> and <code>T</code> are replaced by the class, importance and topic respectively. For example:
** <code>I C T</code>, e.g. [[:Category:Mid-importance B-Class Geology articles]]
** <code>C T of I</code>, e.g. [[:Category:C-Class Andhra Pradesh articles of Low-importance]]
** <code>C I T</code>, e.g. [[:Category:B-Class High-importance Pornography articles]]
** <code>C, I T</code>, e.g. [[:Category:Stub-Class, Top-importance Economics articles]]

==== Optional parameters ====
* <code>'''QII_SUPPRESS_NA'''</code> &ndash; can be set to ''yes'' to stop categories being added when either class or importance is "NA". These can also be set individually:
** <code>'''QII_SUPPRESS_NA_CLASS'''</code> &ndash; can be set to ''yes'' to stop categories being added when class=NA
** <code>'''QII_SUPPRESS_NA_IMPORTANCE'''</code> &ndash; can be set to ''yes'' to stop categories being added when importance=NA
* <code>'''QII_UNASSESSED_APPENDIX'''</code> &ndash; text to append to the class when it is "Unassessed", e.g. {{para|QII_UNASSESSED_APPENDIX|-Class}}

=== Image-needed note ===
{|class="wikitable mw-collapsible" style="align: right; width: 40%;"
!Syntax
|-
|<syntaxhighlight lang="wikitext">
|image-needed={{{needs-image|}}}
 |IM_IMAGE =
 |image-details={{{details|}}}
 |image-location={{{location|}}}
 |IM_LOCATION_CATEGORY =
 |image-topic={{{topic|}}}
 |IM_TOPIC_CATEGORY =
 |image-type={{{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 ====
* <code>'''image-needed'''</code> &ndash; pass through whichever parameter you are using to trigger this note, e.g. {{para|image-needed|<nowiki>{{{needs-image|}}}</nowiki>}}.

==== Optional parameters ====
* <code>'''IM_IMAGE'''</code> &ndash; specifies the icon to be used (without the File namespace prefix); the default is [[File:Camera-photo.svg|20px]] (<code><nowiki>[[File:Camera-photo.svg|20px]]</nowiki></code>).
* <code>'''image-type'''</code> &ndash; 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. {{para|image-type|<nowiki>{{{type|}}}</nowiki>}}.
* <code>'''image-details'''</code> &ndash; to allow an editor to pass more details about the required image, e.g. {{para|image-details|<nowiki>{{{details|}}}</nowiki>}}.
* <code>'''image-location'''</code> &ndash; pass this parameter through to allow an editor to specify the location of the requested image, e.g. {{para|image-location|<nowiki>{{{location|}}}</nowiki>}}. This will also populate categories of the form [[:Category:Wikipedia requested photographs in Scotland]].
* '''<code>IM_LOCATION_CATEGORY</code>''' &ndash; a default category to use when the location is not specified or leads to a non-existent category.
* '''<code>image-topic</code>''' &ndash; pass this through to allow an editor to specify a topic area that the photograph relates to, e.g. {{para|image-topic|<nowiki>{{{topic|}}}</nowiki>}}. This will populate categories such as [[:Category:Wikipedia requested photographs of toys]].
* '''<code>IM_TOPIC_CATEGORY</code>''' &ndash; a default category in case the topic is not specified or leads to a non-existent category, e.g. {{para|IM_TOPIC_CATEGORY|Wikipedia requested images of politics}}.

=== Collaboration note ===
{|class="wikitable mw-collapsible" style="float: right; width: 40%;"
!Syntax
|-
|<syntaxhighlight lang="wikitext">
|collaboration-candidate={{{**PARAMETER**|}}}
|collaboration-current={{{**PARAMETER**|}}}
|collaboration-past={{{**PARAMETER**|}}}
 |COLL_LINK          = 
 |COLL_TEXT          =
 |COLL_IMAGE         = 
 |COLL_CANDIDATE_CAT = 
 |COLL_CURRENT_CAT   = 
 |COLL_PAST_CAT      = 
</syntaxhighlight>
|}
This feature enables a project collaboration system to be integrated into a project banner. The following parameters are used:

==== Required parameters ====
*<code>'''collaboration-candidate'''</code> &ndash; pass the parameter that will trigger the collaboration candidate note, if used, e.g. {{para|collaboration-candidate|<nowiki>{{{collaboration-candidate|}}}</nowiki>}}
*<code>'''collaboration-current'''</code> &ndash; the parameter that will trigger the current collaboration note, if used. E.g. {{para|collaboration-current|<nowiki>{{{collaboration|}}}</nowiki>}}
*<code>'''collaboration-past'''</code> &ndash; the parameter that will trigger the past collaboration note, if used. e.g. {{para|collaboration-past|<nowiki>{{{past-collaboration|}}}</nowiki>}}
*<code>'''COLL_LINK'''</code> &ndash; the full link to where the review for the particular article is held. E.g. {{para|COLL_LINK|Wikipedia:WikiProject Paranormal/Collaboration}}

==== Optional parameters ====
*<code>'''COLL_TEXT'''</code> &ndash; the text to display in place of the default "project collaboration", e.g. {{para|COLL_TEXT|Collaboration of the Month}}
*<code>'''COLL_IMAGE'''</code> &ndash; the name of the image to use. If not specified then [[File:Crystal 128 kuser.png|30px]] is used.
*<code>'''COLL_CANDIDATE_CAT'''</code> &ndash; if defined, pages using {{para|candidate|yes}} will be categorised into this category, e.g. {{para|COLL_CANDIDATE_CAT|Paranormal collaboration candidates}}  → [[:Category:Paranormal collaboration candidates]]
*<code>'''COLL_CURRENT_CAT'''</code> &ndash; if defined, pages using {{para|current|yes}} will be categorised into this category, e.g. {{para|COLL_CURRENT_CAT|Paranormal collaborations}}  → [[:Category:Paranormal collaborations]]
*<code>'''COLL_PAST_CAT'''</code> &ndash; if defined, pages using {{para|past|yes}} will be categorised into this category, e.g. {{para|COLL_PAST_CAT|Past paranormal collaborations}}  → [[:Category:Past paranormal collaborations]]

=== A-class review note ===
{|class="wikitable mw-collapsible" style="float: right; width: 40%;"
!Syntax
|-
|<syntaxhighlight lang="wikitext">
|a class={{{**PARAMETER**|}}}
 |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 ====
*<code>'''a class'''</code> &ndash; the parameter that will trigger the note.  Accepted values are "pass", "fail", "current" (any capitalisation); everything else is treated as null.  {{nowrap|''Eg: '''<code><nowiki>a class={{{A-Class|}}}</nowiki></code>'''''}}
*<code>'''ACR_SUBPAGE_LINK'''</code> &ndash; the full link to where the review for this particular article is held. {{nowrap|''Eg: '''<code><nowiki>Wikipedia:WikiProject Tulips/Assessment/{{SUBJECTPAGENAME}}</nowiki></code>'''''}}
*<code>'''ACR_REVIEW_LINK'''</code> &ndash; the full link to the main A-Class review page (where instructions etc. are held).  {{nowrap|''Eg: '''<code><nowiki>Wikipedia:WikiProject Tulips/Review#A-Class review</nowiki></code>'''''}}

==== Optional parameters ====
*<code>'''ACR_PASS_CAT'''</code> &ndash; pages using {{para|a class|pass}} will be categorised into this category. {{nowrap|''Eg: '''<code><nowiki>Successful requests for Tulips A-Class review</nowiki></code>''' → [[:Category:Successful requests for Tulips A-Class review]]''}}
*<code>'''ACR_FAIL_CAT'''</code> &ndash; pages using {{para|a class|fail}} will be categorised into this category. {{nowrap|''Eg: '''<code><nowiki>Failed requests for Tulips A-Class review</nowiki></code>''' → [[:Category:Failed requests for Tulips A-Class review]]''}}
*<code>'''ACR_CURRENT_CAT'''</code> &ndash; pages using {{para|a class|current}} will be categorised into this category. {{nowrap|''Eg: '''<code><nowiki>Current requests for Tulips A-Class review</nowiki></code>''' → [[:Category:Current requests for Tulips A-Class review]]''}}
*<code>'''ACR_IMAGE'''</code> &ndash; a custom image can be set, using the same syntax as for other note images.  {{nowrap|''Eg: '''<code><nowiki>Exquisite-kfind.png</nowiki></code>''' ''}}
*<code>'''ACR_SIZE'''</code> &ndash; a custom image size can be set, using the usual note syntax. {{nowrap|''Eg: '''<code><nowiki>20x20px</nowiki></code>''' ''}}
*<code>'''ACR_INVALID_CAT'''</code>  &ndash; pages specifying the A Class parameter without a valid SUBPAGE_LINK page existing will be categorised into this category.
*<code>'''ACR_PRELOAD'''</code>  &ndash; preload template, to be used when creating a new A-class review discussion page ([[Wikipedia:WikiProject Military history/Review/A-Class review preload boilerplate|example]]).

=== Peer review note ===
{|class="wikitable mw-collapsible" style="float: right; width: 40%;"
!Syntax
|-
|<syntaxhighlight lang="wikitext">
|peer review={{{**PARAMETER**|}}}
|old peer review={{{**PARAMETER**|}}}
 |peer review title={{{**PARAMETER**|}}}
 |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 ====
*<code>'''peer review'''</code> &ndash; the parameter that will trigger the active peer review note; should be passed through, e.g. {{para|peer review|<nowiki>{{{peer-review|}}}</nowiki>}}
*<code>'''old peer review'''</code> &ndash; the parameter that will trigger the old peer review note; should be passed through, e.g. {{para|old peer review|<nowiki>{{{old-peer-review|}}}</nowiki>}}
*<code>'''PR_LINK'''</code> &ndash; the full link to where the review for this particular article is held, e.g. {{para|PR_LINK|Wikipedia:WikiProject Tulips/Assessment}}

==== Optional parameters ====
*<code>'''PR_IMAGE'''</code> &ndash; the name of the image to use. If not specified then [[File:Exquisite-kfind.png|30px]] is used.
*<code>'''PR_CAT'''</code> &ndash; if defined, pages using {{para|peer review|yes}} will be categorised into this category, e.g. {{para|PR_CAT|Requests for Tulips peer review}} → [[:Category:Requests for Tulips peer review]]
*<code>'''PR_OLD_CAT'''</code> &ndash; if defined, pages using {{para|old peer review|yes}} will be categorised into this category.
*<code>'''peer review title'''</code> &ndash; 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.
*<code>'''PR_INVALID_CAT'''</code>  &ndash; if defined, pages without a valid existing peer review page will be categorised into this category.

<includeonly>{{Sandbox other||
[[Category:Pages related to the WikiProject meta banner|Auxiliary]]
}}</includeonly>