Template:CheckElement/doc

Template page

Template that returns an error message if the first argument is not valid for use with other nuclide templates helper templates.

Usage

When using a string that is not a valid element name or symbol or "x" or "element", an error message is returned, like so:

  • {{CheckElement|C}} will return ""
  • {{CheckElement|Carbon}} will return ""
  • {{CheckElement|Blablabla}} will return "The element Blablabla does not exist."

The "link=yes" argument is also supported; if the element name or symbol has no associated link, an error message is returned, like so:

  • {{CheckElement|link=yes|C}} will return ""
  • {{CheckElement|link=yes|Carbon}} will return ""
  • {{CheckElement|link=yes|X}} will return "The generic element 'X' does not have a page to link to."

When using a common name for an element that goes against the OODA WIKI style guide for element names, a warning message will be returned. There are currently three such names:

  • {{CheckElement|Aluminum}} will return "Aluminum is not a valid way to spell aluminium."
  • {{CheckElement|Sulphur}} will return "Sulphur is not a valid way to spell sulfur."
  • {{CheckElement|Cesium}} will return "Cesium is not a valid way to spell caesium."

This template can be used in other templates to check for error before calling other templates that require a valid element or symbol like so:

{{#if:{{CheckElement|{{{element argument}}}|link={{{link|}}} }}
 | Error message (shown when the element is invalid).
 | Normal message (shown when the element is valid).
}}

Template Data

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for CheckElement

No description.

Template parameters

ParameterDescriptionTypeStatus
11

no description

Unknownoptional
linklink

no description

Unknownoptional
nocategorynocategory

no description

Unknownoptional

See also