Template:Class mask/doc

This template is designed for use in WikiProject banners, and provides an easy way to construct a bespoke class mask. The class parameter must be passed to the template as the first unnamed parameter.

Implementation in Template:WPBannerMeta

The template provides the default class masks for WikiProject's quality scales, and is also used by the majority of projects which use a custom class mask. It can be used in two different ways, either

• the subpage method, with WPBannerMeta set to |QUALITY_SCALE=subpage in the WikiProject's banner template and {{Class mask}} called from its /class subpage. In this case, specific guidance on how the template works with the chosen parameters is displayed on this page.

or

• the inline method, where WPBannerMeta is configured with |QUALITY_SCALE=inline and {{Class mask}} is called directly as the value of its |class= parameter.

Subpage method

When used on a /class subpage (with |QUALITY_SCALE=subpage supplied to WPBannerMeta on the root banner template page), the template should be called in the following way:

{{Class mask<noinclude>/templatepage</noinclude>|1={{{class|}}}
 |topic=
 |all other optional parameters desired, one per line…
}}

The ‎<noinclude>...‎</noinclude> tags allow the documentation from {{Class mask/templatepage}} to be displayed directly on the banner template's /class subpage, where it can provide useful information and category prompts for WikiProject admins and other interested users without any adverse effects to the banner template.

• the |topic= parameter defines the main naming scheme of the assessment categories used by the project (i.e. the part of its assessment category names that comes after Category:Whatever-Class and before articles) and is used to check the existence of the categories that are required. For example, if your project uses categories such as Category:B-Class mathematics articles, etc., then set |topic=mathematics.
  • if the template uses task forces, the parameters |topic1=, |topic2=, |topic3=, |topic4=, |topic5= and |topic6= can be used to check for the corresponding categories needed by each.

Neither of the above are required for the inline method below.

Inline method

When used "inline" (e.g. with |QUALITY_SCALE=inline), the call to /templatepage insides the ‎<noinclude>...‎</noinclude> tags and the |topic= parameter(s) are not used, and the template should be called in the following way:

{{Class mask |1={{{class|}}} |optional parameters}}

Bear in mind that if the banner uses any hooks (e.g. the taskforce hook), you will need to insert the call to {{Class mask}} with the appropriate options each time {{{class|}}} is supposed to be used as the value of a parameter. Therefore, the subpage method may be more expedient in these cases.

Optional parameters

• If one or more of these nine is set to no, the class will be switched off. Their default is yes:
  • |fa= – Featured Article
  • |fl= – Featured List
  • |a= – A-Class
  • |ga= – Good Article
  • |b= – B-Class
  • |c= – C-Class
  • |start= – Start-Class
  • |stub= – Stub-Class
  • |list= – List-Class
• |FQS= – if set to yes, these seven additional assessment classes are activated (FQS stands for Full Quality Scale). Undesired classes may then be switched off individually by setting them to no. When |FQS= is absent, setting one or more to yes will switch on only that class.
  • |category= – Category-Class
  • |disambig= – Disambig-Class
  • |draft= – Draft-Class
  • |file= – File-Class
  • |portal= – Portal-Class
  • |project= – Project-Class
  • |template= – Template-Class
• If either of these is set to yes, that class will be switched on. The default is no, regardless of the |FQS= setting:
  • |fm= – Featured Media
  • |redirect= – Redirect-Class
• |forceNA= - if set to yes, will automatically classify pages tagged as |class=NA depending on the namespace of the page. The default setting is no.
• |b1=, |b2=, |b3=, |b4=, |b5=, |b6= - if the B-class checklist is used, these parameters must be passed through.

The lowercase parameter syntax

Add a class in lowercase as the name of a parameter followed by the value "yes". For example, |future=yes would add the

Future

class. This is the simplest way of adding a class but has the following two limitations:

• The name of the class must have an initial capital letter and all following letters in lowercase. In other words, the capitalisation must be of the form Xxxxxx.
• It is not possible to use this method to add a shortcut or alternative alias for a different class, for example "Cur" for Current-class.

If either of these are required, the uppercase parameter syntax must be used (see below).

If |FQS=yes is used, then a value of "no" may be used to switch off that individual class. Thus, on a /class subpage:

{{Class mask<noinclude>/templatepage</noinclude>|1={{{class|}}}
 |topic=physics
 |FQS=yes
 |portal=no
}}

would support six of the seven additional classes listed above but not support Portal-Class.

The UPPERCASE parameter syntax

Add a class in UPPERCASE as the name of a parameter followed by the exact, case-sensitive name of the class as the value of the parameter. For example,

|SIA=SIA

would add SIA-Class and

|CHEESECAKE=CheeseCake

would add CheeseCake-Class.

You can use this method to add a shortcut or alias for a class, too, as in the case of

|future=yes
|FUT=Future

which would have the effect that defining either |future= or |fut= (not case sensitive) with a valid value would result in an assessment into Future-Class for that page.

You can add as many aliases for a class as needed, so this would work just as well for SIA-Class,

|SIA=SIA
|SETINDEX=SIA
|SET INDEX ARTICLE=SIA

and would mean that an input of |sia=, |setindex= or |set index article= (again, these are case-insensitive) would each result in an SIA-Class page assessment.

Examples

Example 1: subpage

The following code is placed in the banner template,

|QUALITY_SCALE=subpage
 |class={{{class|}}}

and on the /class subpage (for example {{WikiProject Zimbabwe}} uses the subpage Template:WikiProject Zimbabwe/class), the following code is used:

{{Class mask<noinclude>/templatepage</noinclude>|1={{{class|}}}
 |topic=Zimbabwe
 |FQS=yes
 |redirect=yes
}}

In this case all seven of the "extended" quality classes are used, plus the additional Redirect-Class, and because the |topic= parameter is set, specific documentation will be displayed on the /class subpage for it.

Example 2: inline

The following code is placed in the banner template,

|QUALITY_SCALE=inline
 |class={{Class mask |1={{{class|}}} |FQS=yes |redirect=yes |fm=yes}}

activating all seven extended quality classes, plus the additional Redirect- and FM- classes.

Subtemplates

• {{Class mask/b}} - the mask for B-checklist parameters
• {{Class mask/sandbox}} - the template sandbox, used for experimentation
• {{Class mask/templatepage}} - the documentation that is displayed on /class subpages
  • {{Class mask/templatepage/row}} - used by /templatepage
• {{Class mask/doc}} - the documentation you are reading now
  • {{Class mask/doc/custom}} - for information on building your own class mask

Instances

• This shows all /class subpages which use this template.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Class mask in articles based on its TemplateData.

TemplateData for Class mask

This template provides the project-specific valid Wikipedia 1.0 assessment scheme classes to Template:WPBannerMeta

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Assessment class	1	Passthrough for {{{class}}} parameter from Template:WPBannerMeta Suggested values {{{class|}}} Example {{{class|}}} Auto value {{{class|}}}	Content	required
topic	topic	no description	Unknown	optional
fa	fa	no description	Unknown	optional
fl	fl	no description	Unknown	optional
a	a	no description	Unknown	optional
ga	ga	no description	Unknown	optional
b	b	no description	Unknown	optional
c	c	no description	Unknown	optional
start	start	no description	Unknown	optional
stub	stub	no description	Unknown	optional
list	list	no description	Unknown	optional
FQS	FQS	no description	Unknown	optional
category	category	no description	Unknown	optional
disambig	disambig	no description	Unknown	optional
draft	draft	no description	Unknown	optional
file	file	no description	Unknown	optional
portal	portal	no description	Unknown	optional
project	project	no description	Unknown	optional
template	template	no description	Unknown	optional
fm	fm	no description	Unknown	optional
redirect	redirect	no description	Unknown	optional
forceNA	forceNA	no description	Unknown	optional
b1	b1	no description	Unknown	optional
b2	b2	no description	Unknown	optional
b3	b3	no description	Unknown	optional
b4	b4	no description	Unknown	optional
b5	b5	no description	Unknown	optional
b6	b6	no description	Unknown	optional
topic1	topic1	no description	Unknown	optional
topic2	topic2	no description	Unknown	optional
topic3	topic3	no description	Unknown	optional
topic4	topic4	no description	Unknown	optional
topic5	topic5	no description	Unknown	optional
topic6	topic6	no description	Unknown	optional