Template:WPBannerMeta/doc: Difference between revisions

{{tocleft}}

{{clear}}

|MAIN_TEXT          =  

|MAIN_ARTICLE        =  

|MAIN_CAT            =  

|attention={{{attention|}}}

|MAIN_TEXT          =  

|MAIN_ARTICLE        =  

|MAIN_CAT            =  

|attention={{{**PARAMETER**|}}}

WPBannerMeta takes two different types of parameters, formatting and display. The 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 (eg. <code><nowiki>|PROJECT=</nowiki></code> and <code><nowiki>|NOTE_1_CAT= </nowiki></code>). 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 (<code><nowiki>|class=</nowiki></code>, <code><nowiki>|importance=</nowiki></code>, etc.) and they must be 'passed through' the project banner to the meta-template underneath. To 'pass' the parameter <code>foo</code>, you need to include the code {{nowrap|<code><nowiki>foo={{{foo|}}}</nowiki></code>}}.

===Simple options===

**<code>'''substcheck'''</code> &ndash; this allows the template to detect if it has been substituted instead of transcluded and give an error message. '''''<code><nowiki>substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly></nowiki></code>'''''

**<code>'''small'''</code> ''(Required)'' &ndash; the size parameter ''must'' be passed through the template to enable the correct display. {{nowrap|''Eg: '''<code><nowiki>small={{{small|}}}</nowiki></code>'''''}}

**<code>'''<code><nowiki>BANNER_NAME={{subst:FULLPAGENAME}}</nowiki></code>'''</code> ''(Required)'' &ndash; the full page name of the banner. {{nowrap|''Eg: '''<code><nowiki>Template:WikiProject Tulips</nowiki></code>'''''}}

*<code>'''PROJECT_LINK'''</code> &ndash; it is assumed that the project is located at '''<code>"Wikipedia:WikiProject &lt;PROJECT>"</code>'''. If this is not the case, then define the full link to the project page in this parameter. {{nowrap|''Eg: '''<code>Wikipedia:WikiProject Tulips</code>'''''}}

**<code>'''IMAGE_LEFT_SMALL'''</code> &ndash; the size of <code>IMAGE_LEFT</code>, when the banner is displayed in 'small style'. Default is 40px. {{nowrap|''Eg: '''<code><nowiki>25px</nowiki></code>'''''}}

**<code>'''IMAGE_LEFT_LARGE'''</code> &ndash; the size of <code>IMAGE_LEFT</code> in normal display. Default is 80px. {{nowrap|''Eg: '''<code><nowiki>50px</nowiki></code>'''''}}

**<code>'''IMAGE_RIGHT_SMALL'''</code> &ndash; the size of <code>IMAGE_RIGHT</code>, when the banner is displayed in 'small style'. Default is 40px. {{nowrap|''Eg: '''<code><nowiki>25px</nowiki></code>'''''}}

**<code>'''IMAGE_RIGHT_LARGE'''</code> &ndash; the size of <code>IMAGE_RIGHT</code> in normal display. Default is 80px. {{nowrap|''Eg: '''<code><nowiki>50px</nowiki></code>'''''}}

*<code>'''MAIN_TEXT'''</code> &ndash; the default text is "''This article is within the scope of '''<nowiki>[[WikiProject {{{PROJECT_LINK}}}]]</nowiki>''', a collaborative effort to improve the coverage of '''<nowiki>{{{PROJECT or MAIN_ARTICLE}}}</nowiki>''' articles on Wikipedia. If you would like to participate, please visit the project page, where you can join the '''<nowiki>[[Talk:{{{PROJECT_LINK}}}]]</nowiki>''' discussion and see a list of open tasks.''" If defined, the alternate message will be displayed.

**<code>'''MAIN_ARTICLE'''</code> &ndash; the default article is <code>PROJECT</code>; alternatively, the linked article can be changed to either a raw article title or more complicated text. {{nowrap|''Eg: (default) '''<code><nowiki>tulips</nowiki></code>''' &rarr; '''"...the coverage of [[tulip]]s on Wikipedia..."'''}} or (alternate) '''<code><nowiki>[[tulip]]s, [[liliaceae]] and related articles</nowiki></code>''' &rarr; '''"...the coverage of [[tulip]]s, [[liliaceae]] and related articles on Wikipedia..."'''

*<code>'''BOTTOM_TEXT'''</code> &ndash; if defined, contains text that will appear across the bottom of the banner and above the [[#Collapsed section|collapsed section]] (if one is present). Please '''''do not''''' use this parameter to '[[hooking|hook]]' extra code to the bottom of the template &ndash; see the [[#Hooks|''hooks'']] section below for a better solution.

<br clear=all>

|<pre style="font-size:85%">

{{WPBannerMeta

  |substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>

  |small={{{small|}}}

  |category={{{category|¬}}}

  |listas={{{listas|}}}

|IMAGE_LEFT_SMALL = 25px

|IMAGE_LEFT_LARGE = 50px

}}</pre>

|}

:Produces:

{{WPBannerMeta

|IMAGE_LEFT_SMALL = 25px

|IMAGE_LEFT_LARGE = 50px

|category=no

}}

**<code>'''QUALITY_SCALE'''</code> &ndash; configures the quality scale; possible options are:

***standard &ndash; enables the 'standard' quality scale ([[WP:FA|FA]], [[WP:ACLASS|A]], [[WP:GA|GA]], [[WP:BCLASS|B]], C, Start, [[WP:STUB|Stub]], [[WP:FL|FL]], List, NA). (This is the default behaviour, if the ''class'' parameter is used.)

***inline &ndash; allows for a simple custom quality scale to be used, generally used with {{tl|Class mask}}.

***subpage &ndash; allows for a more complex custom quality scale to be used using a subpage called ''/class''. See [[#Custom masks|custom masks]] below for further details.

**:<code><nowiki>|auto=inherit</nowiki></code>, to show that the class has automatically been inherited from other WikiProject's assessments on the same page;

**:<code><nowiki>|auto=length</nowiki></code>, to show that the class has automatically been deduced from the length of the article.

**<code>'''b1'''</code>, <code>'''b2'''</code>, <code>'''b3'''</code>, <code>'''b4'''</code>, <code>'''b5'''</code>, <code>'''b6'''</code> &ndash; the six B-class criteria parameters should only be passed through if the [[Template:WPBannerMeta/hooks/bchecklist|B-class checklist hook]] is used.

*<code>'''importance'''</code>&ndash; if defined, enables the standard importance scale (Top, High, Mid, Low, NA, Unknown). {{nowrap|''Eg: '''<code><nowiki>importance={{{importance|}}}</nowiki></code>'''''}}

***subpage &ndash; allows for a more complex custom importance/priority scale to be used using a subpage called ''/importance''.

*<code>'''ASSESSMENT_LINK'''</code> &ndash; the link to a WikiProject-specific quality (and/or importance) scale. If there is a page at '''<code>"Wikipedia:WikiProject &lt;PROJECTLINK>/Assessment"</code>''' then this will be used by default. To override this, you can set this parameter to '''no'''. For more details, see [[Template:WPBannerMeta/Assessment link|here]].

*<code>'''COMMENTS'''</code>&ndash; some projects may want to use a subpage of the article's talk page to post brief, assessment-related comments about the article. If these comments are placed in a "'''<code><nowiki>{{FULLPAGENAME}}/Comments</nowiki></code>'''" subpage, then this parameter will cause the banner to automatically display. {{nowrap|''Eg: '''<code><nowiki>yes</nowiki></code>'''''}}

**<code>'''COMMENTS_CAT'''</code>&ndash; if this parameter is defined, articles which have comments are sorted into [[:Category:COMMENTS_CAT|Category:<code>COMMENTS_CAT</code>]]. By default, these pages are categorised into [[:Category:Project articles with comments|<tt>PROJECT</tt> articles with comments]]. {{nowrap|''Eg: (alternate) '''<code><nowiki>Tulip and Daffodil articles with comments</nowiki></code>''' → [[:Category:Tulip and Daffodil articles with comments]]}}''. A value of <code>none</code> results in no categorisation.

|<pre style="font-size:85%">

{{WPBannerMeta

  |substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>

  |small={{{small|}}}

  |category={{{category|¬}}}

  |listas={{{listas|}}}

|QUALITY_SCALE      = extended

  |class={{{class|}}}

  |auto={{{auto|}}}

  |importance={{{importance|}}}

|COMMENTS            = yes

  |COMMENTS_CAT      =  

:Produces:

{{WPBannerMeta

  |small={{{small|}}}

  |category={{{category|¬}}}

  |listas={{{listas|}}}

|QUALITY_SCALE    = extended

  |class  = GA

  |importance = Top

|COMMENTS            = yes

  |COMMENTS_CAT      =  

|<pre style="font-size:85%">

{{WPBannerMeta

  |substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>

  |small={{{small|}}}

|QUALITY_SCALE      = extended

  |class={{{class|}}}

|attention={{{attention|}}}

  |ATTENTION_CAT    =  

  |NOTE_2_TEXT      = An [[audio file format|audio file]] has been created of this article.

  |NOTE_2_IMAGE      = Nuvola apps arts.png

}}</pre>

|}

:Produces:

{{WPBannerMeta

|small  = {{{small|}}}

  |category={{{category|¬}}}

  |listas = {{{listas|}}}

|QUALITY_SCALE      = extended

  |class  = C

|attention=yes

  |ATTENTION_CAT      =  

WPBannerMeta can accommodate up to five [[task force]]s, each with its own image, links and importance scale, if desired. The following parameters are available:

*<code>'''tf 1'''</code> &ndash; this parameter ''must'' be passed through to enable and trigger the display of the task force section. {{nowrap|''Eg: '''<code><nowiki>tf 1={{{floridiae|}}}</nowiki></code>'''''}}

**<code>'''TF_1_NAME'''</code> &ndash; the way the task force's name will appear in its piped link; redundant when {{para|TF_1_TEXT}} is used. {{nowrap|''Eg: '''<code><nowiki>the Floridiae task force</nowiki></code>'''''}}

**<code>'''TF_1_NESTED'''</code> &ndash; if defined, a link of the form "'''/ <nowiki>[[{{{TF_1_LINK}}}|{{{TF_1_NESTED}}}]]</nowiki>'''" is added after the main project's name when the banner is collapsed inside a {{tl|WikiProjectBannerShell}}. {{nowrap|''Eg: '''<code><nowiki>Floridiae</nowiki></code>'''''}}

**<code>'''tf 1 importance'''</code>&ndash; if defined, enables the use of a separate importance (or priority, if used) scale for the task force.{{nowrap|''Eg: '''<code><nowiki>tf 1 importance={{{floridiae-importance|}}}</nowiki></code>'''''}}

**<code>'''TF_1_ASSESSMENT_CAT'''</code> ''(Required if quality or importance assessments are used)'' &ndash; the assessment category to be used for the task force-specific quality and importance assessments. Identical in syntax to {{para|ASSESSMENT_CAT}}. {{nowrap|''Eg: '''<code><nowiki>Floridiae articles</nowiki></code>''' → [[:Category:FA-Class Floridiae articles]]}}''

|<pre style="font-size:85%">

{{WPBannerMeta

  |substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>

  |small={{{small|}}}

  |category={{{category|¬}}}

  |listas={{{listas|}}}

|QUALITY_SCALE        = standard

  |class={{{class|}}}

|tf 1={{{floridiae|}}}

  |TF_1_NAME          = the Floridiae task force

  |TF_1_NESTED        = Floridiae

  |TF_1_TEXT          =  

  |tf 1 importance={{{floridiae-importance}}}

  |TF_1_ASSESSMENT_CAT = Floridiae articles

{{WikiProjectBannerShell|1=

{{WPBannerMeta

|QUALITY_SCALE    = standard

  |class  = FA

|tf 1 = yes

  |TF_1_NAME      = the Floridiae task force

  |TF_1_NESTED    = Floridiae

  |TF_1_TEXT      =  

  |tf 1 importance= Top

  |TF_1_ASSESSMENT_CAT= Floridiae articles