Jump to content

Template:WikiProject Mathematics/doc

From Wikipedia, the free encyclopedia

Usage

[edit]

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.

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

[edit]

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

[edit]
{{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

[edit]

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

[edit]
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.

ParameterDescriptionTypeStatus
Assessment classclass

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
Linerequired
Improvement prioritypriority 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
Linerequired
Featured on Portalportal

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
Booleanoptional
Auto-categorizecategory

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
Booleanoptional
Custom SORTKEYlistas

The value of this parameter will become the page's new SORTKEY, controlling where it appears in auto-generated lists and categories.

Lineoptional
Custom linkshortcut

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 nameoptional