Template:Class mask/doc

This is a documentation subpage for Template:Class mask.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 337,000 pages, or roughly 2% of all pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

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 Module:WikiProject banner

The template provides the default class masks for WikiProject's quality scales, and is also used by a few projects which have opted out of the standard scale and use a custom class mask by setting |QUALITY_CRITERIA=custom and |QUALITY_SCALE=subpage in the WikiProject's banner template, and creating a /class subpage.

When used on a /class subpage, the template should be called in the following way: <syntaxhighlight lang="wikitext" style="margin-left: 2.5em; max-width: 48em;">

In order for this documentation to relate specifically to the WikiProject, please define the |topic= parameter.

Template documentation

This template is used on approximately 337,000 pages, or roughly 2% of all pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This page holds the custom class mask for the Template:Class mask. It uses {{class mask}}, a template for constructing class masks according to individual WikiProjects' wishes. The following table shows the output of the mask, with the current parameter definitions, for different inputs and namespaces.

Classification based on class parameter

Input (not case-specific)	Class	Category	Population
fa	FA	Category:FA-Class articles	1,228
a	A	Category:A-Class articles	1,202
ga	GA	Category:GA-Class articles	1,257
b	B	Category:B-Class articles	1,263
c	C	Category:C-Class articles	655
start	Start	Category:Start-Class articles	1,268
stub	Stub	Category:Stub-Class articles	1,266
fl	FL	Category:FL-Class articles	1,346
list	List	Category:List-Class articles	1,293
na	NA	Category:NA-Class articles	1,367

Classification of redirects

If the WikiProject banner is placed on the talk page of a redirect (in any namespace) and the class parameter is not defined, then the page will automatically be classified as NA-class and placed in Category:NA-Class articles.

Classification based on namespace

In addition, if class is empty, undefined or unrecognized, then the class will be deduced from the namespace of the page when possible.

Namespace	Class	Category	Population
User talk	NA	Category:NA-Class articles	1,367
File talk
TimedText talk
Category talk
Portal talk
Template talk
Module talk
Project talk
Draft talk
Help talk
MediaWiki talk

In all other circumstances, articles will be classed as Unassessed and placed in Category:Unassessed-Class articles.

This documentation is automatically generated by Template:Class mask/templatepage.

</syntaxhighlight>

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.

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: <syntaxhighlight lang="wikitext" style="margin-left: 2.5em; max-width: 48em;">

Some of the categories required do not currently exist, and need to be created. Please ensure that the categories below are created to avoid redlinks appearing on talk pages.

Category:FL-Class physics articles – (create)
Category:C-Class physics articles – (create)
Category:List-Class physics articles – (create)
Category:Unassessed physics articles – (create)
Category:NA-Class physics articles – (create)
Category:File-Class physics articles – (create)
Category:Category-Class physics articles – (create)
Category:Disambig-Class physics articles – (create)
Category:Draft-Class physics articles – (create)

Template documentation

This template is used on approximately 337,000 pages, or roughly 2% of all pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This page holds the custom class mask for the Template:Class mask. It uses {{class mask}}, a template for constructing class masks according to individual WikiProjects' wishes. The following table shows the output of the mask, with the current parameter definitions, for different inputs and namespaces.