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 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 custom and subpage in the WikiProject's banner template, and creating a /class subpage.

When used on a  subpage, the template should be called in the following way: The  tags allow the documentation from to be displayed directly on the banner template's   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  and before  ) and is used to check the existence of the categories that are required. For example, if your project uses categories such as , etc., then set 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, the class will be switched off. Their default is  :
 * 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, 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  . When FQS is absent, setting one or more to   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, that class will be switched on. The default is  , regardless of the FQS setting:
 * fm – Featured Media
 * redirect – Redirect-Class
 * forceNA - if set to, will automatically classify pages tagged as NA depending on the namespace of the page. The default setting is.
 * 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, yes would add the   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 yes is used, then a value of "no" may be used to switch off that individual class. Thus, on a  subpage: 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, would add SIA-Class and would add CheeseCake-Class.

You can use this method to add a shortcut or alias for a class, too, as in the case of 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, 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.

Example
The following code is placed in the banner template, and on the  subpage (for example  uses the subpage Template:WikiProject Zimbabwe/class), the following code is used: 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.

Subtemplates

 * - the mask for B-checklist parameters
 * - the template sandbox, used for experimentation
 * - the documentation that is displayed on  subpages
 * - used by
 * - the documentation you are reading now
 * - for information on building your own class mask

Instances

 * [ This] shows all /class subpages which use this template.

TemplateData
{	"description": "This template provides the project-specific valid Wikipedia 1.0 assessment scheme classes to Template:WPBannerMeta", "format": "inline", "paramOrder": [ "1",		"topic", "fa", "fl", "a", "ga", "b", "c", "start", "stub", "list", "FQS", "category", "disambig", "draft", "file", "portal", "project", "template", "fm", "redirect", "forceNA", "b1", "b2", "b3", "b4", "b5", "b6", "topic1", "topic2", "topic3", "topic4", "topic5", "topic6" ],	"params": { "1": {			"label": "Assessment class", "description": "Passthrough for parameter from Template:WPBannerMeta", "example": "", "type": "content", "suggestedvalues": [ ""			],			"autovalue": "", "required": true },		"b1": {}, "b2": {}, "b3": {}, "b4": {}, "b5": {}, "b6": {}, "b": {}, "forceNA": {}, "file": {}, "FQS": {}, "category": {}, "portal": {}, "template": {}, "project": {}, "draft": {}, "disambig": {}, "redirect": {}, "fm": {}, "fa": {}, "fl": {}, "a": {}, "ga": {}, "c": {}, "start": {}, "stub": {}, "list": {}, "topic1": {}, "topic2": {}, "topic3": {}, "topic4": {}, "topic5": {}, "topic6": {}, "topic": {} } }