Template:Nuclide

Template documentation[view] [edit] [history] [purge]

Usage

This section:

The Nuclide templates are to be used for displaying nuclide, isotope and element symbols, specifically in formulae. They can optionally link to the page for the specific nuclide, isotope or element. Here is a list of the various templates and some sample output for carbon-12, with and without links enabled:

Template		Without link	With link `\|link=yes`
{{Chem2}}^{(to improve)}	`{{Chem2\|[[Carbon\|C]]}}`	C	C
{{SimpleNuclide}}	`{{SimpleNuclide\|Carbon\|12\|link=yes}}`	¹² C	¹² C
{{Nuclide}}	`{{Nuclide\|Carbon\|12\|link=yes}}`	¹² ₆C	¹² ₆C
{{ComplexNuclide}}	`{{ComplexNuclide\|Carbon\|12}}`	¹² ₆C	¹² ₆C
{{ComplexNuclide}}	`{{ComplexNuclide\|helium\|2\|anti=yes\|charge=+}}`	² ₂He⁺	² ₂He⁺

Arguments

All the templates accept the same arguments.

1	Required. The name of the element for which to return the isotope symbol
2	The mass number for the isotope. The default value is the mass number of the most common or stable isotope.
3	A string to indicate a nuclear isomer ("m", "m2", etc...) where the nucleus in an excited state. This argument does not require the mass number to be supplied.
`\|link=yes`	Automatically creates a link to the relevant page for the element or isotope. This page may not yet exist for some isotopes, in that case you are encouraged to create the page or create a redirect to “Isotopes of element name”.
`\|anti=yes`	Specify the element is made of anti-matter and that the symbol should therefore be marked with an overline.
`\|charge=`	Specify the charge of an ionized atom.
`\|q=`	Specify the quantity of the atom (useful in chemical formulas, only available in {{ComplexNuclide}}).
m	Specifies that the atom is a nuclear isomer.

Examples

`{{SimpleNuclide\|Carbon}}`	¹² C
`{{SimpleNuclide\|Carbon\|14}}`	¹⁴ C
`{{SimpleNuclide\|link=yes\|Carbon}}`	¹² C
`{{SimpleNuclide\|anti=yes\|Carbon}}`	¹² C
`{{SimpleNuclide\|link=yes\|Carbon\|14}}`	¹⁴ C
`{{SimpleNuclide\|Carbon\|12\|m}}`	^12m C
`{{ComplexNuclide\|link=yes\|anti=yes\|Carbon\|12\|m\|charge=2+}}`	^12m ₆C²⁺
`{{ComplexNuclide\|O\|16\|q=2}}`	¹⁶ ₈O ₂

See User:SkyLined/List of nuclei for a list of all elements supported by these templates.

Dependencies

All of these templates use {{ProtonsForElement}} to check if the element name is valid and, if the link=yes argument is used, check if you're not using the generic "X" or "element".
Some of these templates use {{ProtonsForElement}} to get the element number for a given element.
Some of these templates use {{NeutronsForElement}} to get the default number of neutrons for a given element.
Some of these templates use both {{ProtonsForElement}} and {{NeutronsForElement}} to get the default mass number for a given element.
These templates use {{LinkForElement}} to get the page to link to if the link=yes argument is used.
These templates use {{Physics particle}} to create the HTML output in order to maintain a similar look and feel for all physics symbols.

Incorrect use

Pages that use these templates incorrectly will be added to Category:Pages with incorrect nuclide templates use. Please check there occasionally to make sure there aren't any.

Here are some samples of error messages:

{{Nuclide \|Blabla}}	The element Blabla does not exist.
{{Nuclide \|Aluminum}}	Aluminum is not a valid way to spell aluminium.
{{Nuclide \|Element \|link=yes}}	The generic element 'Element ' does not have a page to link to.

Template Data

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

TemplateData for Nuclide

No description.

Template parameters
Parameter		Description	Type	Status
1	`1`	no description	Unknown	optional
2	`2`	no description	Unknown	optional
3	`3`	no description	Unknown	optional
link	`link`	no description	Unknown	optional
anti	`anti`	no description	Unknown	optional
charge	`charge`	no description	Unknown	optional
nocategory	`nocategory`	no description	Unknown	optional