Template:Maths rating

From Wikipedia, the free encyclopedia
Jump to: navigation, search
WikiProject Mathematics
WikiProject Mathematics
This template is within the scope of WikiProject Mathematics, a collaborative effort to improve the coverage of Mathematics on Wikipedia. If you would like to participate, please visit the project page, where you can join the discussion and see a list of open tasks.
Mathematics rating: Quality unassessed Priority unassessed  Field: Unassessed
Documentation icon Template documentation[view] [edit] [history] [purge]

Usage

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

Please do not simply add this template without filling in the parameters. The List of mathematics articles is very complete and does not depend on this template in any way. The only 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 subcategory of Category:Mathematics articles by priority and Category:Mathematics articles by quality.

Syntax overview

When using the maths rating template, please set each of the three following parameters:

  • class: choose one: FA, FL, GA, A, Bplus, B, Start, Stub, List
  • priority: choose one: Top, High, Mid, Low
  • field: choose one: General, Basics, Analysis, Algebra, Geometry, Applied mathematics, Probability and statistics, Number theory, Discrete, Foundations, Mathematical physics, Topology, History, Mathematicians

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

  • historical: set to Y for articles on a topic with historical interest.
  • ACD: set to Y if the article is undergoing an A-class discussion.
  • vital: set to Y for articles that are in the Vital articles collection.
  • portal: set to Y to place the article in Category:Featured articles on Mathematics Portal if it is a selected article.
  • frequentlyviewed: use to mark articles that are among the most frequently viewed. This parameter is set by VeblenBot, please do not use it manually.
  • small: set to "yes" to make the box small. Does not appear to be used much, if at all.
  • category: set to "no" if the template is being used as a demonstration and you do not want the page it is on to be added to the mathematics categories associated with the class, priority, and field.

Standard template syntax

{{maths rating
| class=            <!--FA, FL, GA, A, Bplus, B, Start, Stub, List-->
| priority =        <!--Top, High, Mid, Low-->
| field=            <!--General, Basics, Analysis, Algebra, Geometry, Applied mathematics, Probability and statistics, Number theory, Discrete, Foundations, Mathematical physics, Topology, History, Mathematicians-->

<!--optional or special purpose-->
| historical=       <!--set to Y for articles on a topic with historical interest-->
| ACD=              <!--set to Y if the article is undergoing an A-class discussion-->
| vital=            <!--set to Y for articles that are in the Vital articles collection; be sure of consensus before setting-->
| portal=           <!--set to Y to place the article in Category:Featured articles on Mathematics Portal-->
| frequentlyviewed= <!--This parameter is set by a bot, not manually to mark articles that are among the most frequently viewed.-->
| small=            <!--set to "yes" when necessary to make the box small-->
| category=         <!--set to "no" to prevent the template from adding categories to a 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.

Case sensitivity and valid input

The class, priority, field, and category parameters are all case-insensitive, but frequentlyviewed and small both require the case-sensitive parameter yes to take effect. Setting these parameters to values besides yes or no does nothing, but setting unrecognized parameters for class or priority can cause errors. At present, all valid inputs for field are:
algebra; analysis; applied; applied mathematics; basics; discrete; discrete mathematics; foundations; foundations, logic, and set theory; general; geometry; history; logic; mathematical physics; mathematician; mathematicians; number theory; probability; probability and statistics; set theory; statistics; topology.
These are semicolon-delimited; both commas and semicolons are allowed in parameters, but no semicolons are used in any valid field inputs, while commas are. Not all values listed above cause distinct results. Applied and applied mathematics refer to the same category; so do discrete and discrete mathematics, and foundations, logic, and set theory can be abbreviated to foundations, logic, or set theory as probability and statistics is identical to either probability or statistics. Also, mathematician is identical to mathematicians.

For any of the fields who should be set to Y (ACD, historical, portal, and vital), providing any value for the parameter will trigger the same response. If one of these is no longer applicable to an article, the parameter should be removed or only include whitespace, not set to N. Each of these flags displays a link and/or message and adds the page to a category.

The priority parameter also has an NA option, but since this template is only designed to be placed on article talk pages, there should never be a reason to use it.

Other properties

Setting |historical=Y if there is no field given produces almost the same result as setting |field=history, except it adds Category:History of subject mathematics articles as well as Category:Mathematics articles related to history of mathematics. The historical flag always adds both categories, while |field=history produces only the latter. Their link in the field display, History, is identical. Setting both the flag and the field would be redundant and confusing unless the article is about the history of the changing views in the history of mathematics. In fact, even then it would still be confusing, so don't do it.

The template also supports a importance parameter which functions identically to priority except for where the template displays the word 'priority' it will instead say 'importance.' Beyond that, there is no reason to use one over the other and no reason to use both together. If they are both used, the importance parameter will be ignored. If the priority parameter is set to blank - if |priority= appears with no argument - then the code considers this a use of priority and ignores importance, except when assigning categories.

Both the comments display and the field parameter depend partly on the existence of other pages. If comments exist at the [[/Comments]] (case-sensitive) subpage of a talk page, the template will display a message with a link to that page. So, if there were comments on the Magic square article (at Talk:Magic square/Comments), then the template on Talk:Magic square would display a notice and link to the comment page. (The comments page is commonly used for an explanation of why an article received a given rating). Not very many articles seem to have comments; Talk:Algorithm is an example of a page where the feature is used.

While some legal values for field are added directly to the template code, others are recognized based on the categories and pages existing elsewhere. For example, if WikiProject Mathematics decides to add a math field called, say, Magic squares, and thus creates a page at Wikipedia:WikiProject Mathematics/Wikipedia 1.0/Magic squares and a category, Category:Mathematics articles related to magic squares, (these names must be in this exact form and are case-sensitive) then the addition of |field=magic squares will be legal and produce a link to that page, displayed as Magic squares, in the field display as well as adding the talk page to the category. If they use different forms for the names, the template will have to be edited to add the new field as an option; many of the field parameters currently in use fall into this category.

Notes for editors

Categories

The |category=no parameter works by surrounding each category with code so that it is only added if the parameter is not set. To add a category somewhere, use
{{#ifeq:{{lc:{{{category|}}} }}|no||<!-- Category added here -->}}
or add it inside the large, already existing section wrapped in the ifeq parser function near the end, where the code for the vital, portal, and historical categories is.

Case-sensitivity

The case-insensitivity for the class and priority is somewhat sensitive. For class, it is assumed that any parameter two or fewer characters long is "intended" to be in all caps (FA, FL, GA), or that the relevant pages and categories linked to have these in their names - for example, Category:FA-Class mathematics articles. It assumes that any longer values are intended to have only the first letter capitalized. For priority, any value except for 'NA' is supposed to have the first letter only capitalized. If adding other values for these parameters, make sure they fit into this scheme or edit the code as needed.

Tables, whitespace, and newlines

The tables in the template have been mostly converted to html-style since the readability benefits of wiki table style are lost when there is so much complexity inside and around the cells, especially since pipes (|) must be replaced with {{!}} inside parser functions and templates. However, two cells require wiki tables inside them. Please be aware that introducing or removing newlines in those areas can break the template, so be careful and test your edits somewhere else first. Also, introducing newlines within <td> tags or outside the <table> tags can change spacing as well. If a particular newline is causing a problem but removing it would make the code much less readable, the newline can be commented out by placing <!-- at the end of the upper line and --> at the beginning of the lower one. You may also wish to view Help:Table and Wikipedia:Line‑break handling for more information.

Categories

The following categories are populated by the field parameter:

See also