Template:WikiProject Mathematics/doc

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

This template is used on approximately 29,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

Shortcut

{{Maths rating}}

Usage

This template is used to categorize and assess articles within WikiProject Mathematics. To classify an article, place the template {{WikiProject Mathematics}} on the article's talk page and fill in the |class= and |priority= parameters.

Please do not simply add this template without filling in the parameters. The purpose of this template is to carry article assessment data.

Anyone can add a maths rating or change an existing rating. These parameters will place the article in the appropriate subcategories of Category:Mathematics articles by priority and Category:Mathematics articles by quality.

Syntax overview

When using this template, please set both of these parameters:

|class= choose one of: FA, FL, GA, A, B, C, Start, Stub, List or NA. (e.g. |class=B)
|priority= choose one of: Top, High, Mid, Low or NA. (e.g. |priority=High)

The following parameters are also available. In general, if you don't know what they mean then you don't need them.

|portal=Y for an article that is a selected article on Portal:Mathematics.
|category=no if the template is being used as a demonstration and you do not want the page it is on to be added to any categories.
|shortcut= adds a custom wikilink within the project banner within the format "Shortcut: [[value]]"; must be a valid page name on this wiki, including the namespace if not in normal articlespace, but without the paired square brackets at both ends.

Standard template syntax

{{WikiProject Mathematics
 | class    = <!--FA, FL, GA, A, B, Start, Stub, List or NA-->
 | priority = <!--Top, High, Mid, Low or NA-->
<!--Optional or special-purpose-->
 | portal   = <!--set to Y to place the article in Category:Featured articles on Mathematics Portal-->
 | category = <!--set to "no" to prevent the template from adding categories to a page-->
 | shortcut = <!--set to valid page name on this wiki to add a link to it within the banner template on this page-->
}}

Syntax details

The main purpose of this template is to show the classifications of articles on their talk pages, as well as to place talk pages in the appropriate categories. Only the first three parameters are required for this. However, other flags can be used to show additional information and categorize the page further.

The template also supports a |importance= parameter which functions identically to |priority=, except for causing the template to display the word 'importance' in the place that it typically displays 'priority.' Beyond that, there is no reason to use one over the other, and still even less reason to use both simultaneously. If they are both used, the |importance= parameter will be ignored. If the |priority= parameter is called but given no value—if |priority= appears as it does here, with no argument—then the parser considers this a valid declaration of |priority= to a null value and will ignore |importance= even if it has an explicit value, except when assigning categories.

TemplateData

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

TemplateData for WikiProject Mathematics

This template is used to categorize and assess Wikipedia pages within WikiProject Mathematics. To classify an article, place this template on the talk page associated with the page you're assessing and fill in the 'class' and 'priority' parameters.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Assessment class	`class`	The Wikipedia 1.0 Assessment class to assign to this page. Set to one of: ['FA', 'FL', 'GA', 'A', 'B', 'C', 'Start', 'Stub', 'List', 'NA'] Suggested values `FA` `FL` `GA` `A` `B` `C` `Start` `Stub` `List` `NA` Example Start	Line	required
Improvement priority	`priority` `importance`	This attempts to define how important this page's subject is to the overall quality of the project's topic on Wikipedia. Set to one of: ['Top', 'High', 'Mid', 'Low', 'NA'] Suggested values `Top` `High` `Mid` `Low` `NA` Example Low	Line	required
Featured on Portal	`portal`	This binary parameter flags the article for inclusion in the "Featured articles" category on Portal:Mathematics when set to: ['Y'] Suggested values `Y` Example Y	Boolean	optional
Auto-categorize	`category`	One of the primary functions of this template is to place pages that transclude it into assessment category used by the project. Defining this to a "falsy" value disables this, often desirable on documentation or testcases subpages. Set to one of: ['yes', 'no'] Default yes Example no Auto value `yes`	Boolean	optional
Custom SORTKEY	`listas`	The value of this parameter will become the page's new SORTKEY, controlling where it appears in auto-generated lists and categories.	Line	optional
Custom link	`shortcut`	This allows an editor to add a custom wikilink to any page of their choosing to be displayed within this template in the format "Shortcut: [[value]]". Must be a valid pagename on this wiki, including namespace if not part of Article space. Example :Category:Super-cool secret pages	Page name	optional