imported>MSGJ: /* Inline method */ fix

2023-02-09T22:15:18Z

Inline method: fix

New page

{{Documentation subpage}}

{{High-use|demo={{ROOTPAGENAME}}}}
{{lua|Module:Redirect}}
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|subpage method]], with WPBannerMeta set to {{Para|QUALITY_SCALE|subpage}} in the WikiProject's banner template and {{Template link general|Class mask|kbd=yes}} called from its <kbd>/class</kbd> subpage. In this case, specific guidance on how the template works with the chosen parameters is displayed on this page.
or
* the [[#Inline method|inline method]], where WPBannerMeta is configured with {{Para|QUALITY_SCALE|inline}} and {{Template link general|Class mask}} is called directly as the value of its {{Para|class}} parameter.

=== Subpage method ===
When used on a <kbd>/class</kbd> subpage (with {{Para|QUALITY_SCALE|subpage}} supplied to WPBannerMeta on the root banner template page), the template should be called in the following way:
<pre style="margin-left: 2.5em; max-width: 48em;">{{Class mask<noinclude>/templatepage</noinclude>|1={{{class|}}}
|topic=
|all other optional parameters desired, one per line…
}}</pre>
The {{Tag|noinclude}} tags allow the documentation from {{Template link general|Class mask/templatepage|kbd=yes}} to be displayed directly on the banner template's <kbd>/class</kbd> 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 {{Para|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 <kbd>''Category:Whatever-Class''</kbd> and before <kbd>''articles''</kbd>) and is used to check the existence of the categories that are required. For example, if your project uses categories such as <kbd>[[:Category:B-Class mathematics articles]]</kbd>, etc., then set {{Para|topic|mathematics}}.
** if the template uses task forces, the parameters {{Para|topic1}}, {{Para|topic2}}, {{Para|topic3}}, {{Para|topic4}}, {{Para|topic5}} and {{Para|topic6}} can be used to check for the corresponding categories needed by each.

Neither of the above are required for the [[#Inline method|inline method]] below.

=== Inline method ===
When used "inline" (e.g. with {{Para|QUALITY_SCALE|inline}}), the call to /templatepage insides the {{Tag|noinclude}} tags and the {{Para|topic}} parameter(s) are not used, and the template should be called in the following way:
<pre style="margin-left: 2.5em; max-width: 48em;">{{Class mask |1={{{class|}}} |optional parameters}}</pre>
Bear in mind that if the banner uses any hooks (e.g. the [[Template:WPBannerMeta/hooks/taskforces|taskforce hook]]), you will need to insert the call to {{Template link general|Class mask|kbd=yes}} with the appropriate options each time <code><nowiki>{{{class|}}}</nowiki></code> 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 <code>no</code>, the class will be switched off. Their default is <code>yes</code>:
** {{Para|fa}} – {{Class/icon|FA}} [[Wikipedia:Featured articles|'''F'''eatured '''A'''rticle]]
** {{Para|fl}} – {{Class/icon|FL}} [[Wikipedia:Featured lists|'''F'''eatured '''L'''ist]]
** {{Para|a}} – {{Class/icon|A}} [[Wikipedia:Content assessment/A-Class criteria|'''A'''-Class]]
** {{Para|ga}} – {{Class/icon|GA}} [[Wikipedia:Good articles|'''G'''ood '''A'''rticle]]
** {{Para|b}} – {{Class/icon|B}} [[Wikipedia:Content assessment/B-Class criteria|'''B'''-Class]]
** {{Para|c}} – {{Class/icon|C}} [[Wikipedia:Content assessment/C-Class criteria|'''C'''-Class]]
** {{Para|start}} – {{Class/icon|Start}} [[Wikipedia:Content assessment/Start-Class criteria|'''Start'''-Class]]
** {{Para|stub}} – {{Class/icon|Stub}} [[Wikipedia:Stub|'''Stub'''-Class]]
** {{Para|list}} – {{Class/icon|List}} [[Wikipedia:Stand-alone lists|'''List'''-Class]]
* {{Para|FQS}} – if set to <code>yes</code>, 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 <code>no</code>. When {{Para|FQS}} is absent, setting one or more to <code>yes</code> will switch on only that class.
** {{Para|category}} – {{Class/icon|Category}} [[Help:Category|'''Category'''-Class]]
** {{Para|disambig}} – {{Class/icon|Disambig}} [[Wikipedia:Disambiguation|'''Disambig'''-Class]]
** {{Para|draft}} – {{Class/icon|Draft}} [[Wikipedia:Drafts|'''Draft'''-Class]]
** {{Para|file}} – {{Class/icon|File}} [[Help:Files|'''File'''-Class]]
** {{Para|portal}} – {{Class/icon|Portal}} [[Wikipedia:Portal|'''Portal'''-Class]]
** {{Para|project}} – {{Class/icon|Project}} [[Wikipedia:WikiProject|'''Project'''-Class]]
** {{Para|template}} – {{Class/icon|Template}} [[Help:Template|'''Template'''-Class]]
* If either of these is set to <code>yes</code>, that class will be switched on. The default is <code>no</code>, regardless of the {{Para|FQS}} setting:
** {{Para|fm}} – {{Class/icon|FM}} [[Wikipedia:Featured pictures|'''F'''eatured '''M'''edia]]
** {{Para|redirect}} – {{Class/icon|FM}} [[Wikipedia:Redirect|'''Redirect'''-Class]]
* {{Para|forceNA}} - if set to <code>yes</code>, will automatically classify pages tagged as {{Para|class|NA}} depending on the namespace of the page. The default setting is <code>no</code>.
* {{Para|b1}}, {{Para|b2}}, {{Para|b3}}, {{Para|b4}}, {{Para|b5}}, {{Para|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, {{Para|future|yes}} would add the {{Class/icon|Future}} <table>{{Class|Future}}</table> 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 {{Para|FQS|yes}} is used, then a value of "no" may be used to switch off that individual class. Thus, on a <kbd>/class</kbd> subpage:
<pre style="margin-left: 2.5em; max-width: 48em;">{{Class mask<noinclude>/templatepage</noinclude>|1={{{class|}}}
|topic=physics
|FQS=yes
|portal=no
}}</pre>
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,
<pre style="margin-left: 2.5em; max-width: 20em;">|SIA=SIA</pre>
would add SIA-Class and
<pre style="margin-left: 2.5em; max-width: 20em;">|CHEESECAKE=CheeseCake</pre>
would add CheeseCake-Class.

You can use this method to add a shortcut or alias for a class, too, as in the case of
<pre style="margin-left: 2.5em; max-width: 20em;">|future=yes
|FUT=Future</pre>
which would have the effect that defining either {{Para|future}} or {{Para|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,
<pre style="margin-left: 2.5em; max-width: 20em;">|SIA=SIA
|SETINDEX=SIA
|SET INDEX ARTICLE=SIA</pre>
and would mean that an input of {{Para|sia}}, {{Para|setindex}} or {{Para|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,
<pre style="margin-left: 2.5em; max-width: 24em;">
|QUALITY_SCALE=subpage
|class={{{class|}}}
</pre>
and on the <kbd>/class</kbd> subpage (for example {{Template link general|WikiProject Zimbabwe|kbd=yes}} uses the subpage [[Template:WikiProject Zimbabwe/class]]), the following code is used:
<pre style="margin-left: 2.5em; max-width: 48em;">
{{Class mask<noinclude>/templatepage</noinclude>|1={{{class|}}}
|topic=Zimbabwe
|FQS=yes
|redirect=yes
}}
</pre>
In this case all seven of the "extended" quality classes are used, plus the additional Redirect-Class, and because the {{Para|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,
<pre style="margin-left: 2.5em; max-width: 48em;">
|QUALITY_SCALE=inline
|class={{Class mask |1={{{class|}}} |FQS=yes |redirect=yes |fm=yes}}
</pre>
activating all seven extended quality classes, plus the additional Redirect- and FM- classes.

== Subtemplates ==
* {{Template link general|Class mask/b}} - the mask for B-checklist parameters
* {{Template link general|Class mask/sandbox}} - the template sandbox, used for experimentation
* {{Template link general|Class mask/templatepage}} - the documentation that is displayed on <kbd>/class</kbd> subpages
** {{Template link general|Class mask/templatepage/row}} - used by <kbd>/templatepage</kbd>
* {{Template link general|Class mask/doc}} - the documentation you are reading now
** {{Template link general|Class mask/doc/custom}} - for information on building your own class mask

== Instances ==
* [{{fullurl:Special:WhatLinksHere/Template:Class mask/templatepage|&hidelinks=1&hideredirs=1}} This] shows all /class subpages which use this template.

== TemplateData ==
{{TemplateData header}}
<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 {{{class}}} parameter from Template:WPBannerMeta",
"example": "{{{class|}}}",
"type": "content",
"suggestedvalues": [
"{{{class|}}}"
],
"autovalue": "{{{class|}}}",
"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": {}
}
}</templatedata><includeonly>

{{Sandbox other||

[[Category:WikiProject templates]]
[[Category:Wikipedia metatemplates]]

}}</includeonly>

Template:Class mask/doc - Revision history

imported>MSGJ: /* Inline method */ fix