Admin: 1 revision imported

2022-09-02T04:13:59Z

1 revision imported

← Older revision	Revision as of 09:43, 2 September 2022
(No difference)

wikipedia>LaundryPizza03: /* Arguments */ grammar, linking

2022-08-03T04:04:12Z

Arguments: grammar, linking

New page

{{documentation subpage}}

{{align|right|{{nbsp|3}}''This section:'' {{view||edit|template=Template:Nuclide templates/doc}}}}

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:
:{| class="wikitable"
! Template
!
! Without link
! With link {{para|link|yes}}
|- style="height:2em;"
| {{tl|Chem2}}(to improve)
| <code><nowiki>{{Chem2|[[Carbon|C]]}}</nowiki></code>
| style="text-align:right" | {{Chem2|C}}
| style="text-align:right" | {{Chem2|[[Carbon|C]]}}
|- style="height:2em;"
| {{tl|SimpleNuclide}}
| <code><nowiki>{{SimpleNuclide|Carbon|12|link=yes}}</nowiki></code>
| style="text-align:right" | {{SimpleNuclide|Carbon|12}}
| style="text-align:right" | {{SimpleNuclide|Carbon|12|link=yes}}
|- style="height:2em;"
| {{tl|Nuclide}}
| <code><nowiki>{{Nuclide|Carbon|12|link=yes}}</nowiki></code>
| style="text-align:right" | {{Nuclide|Carbon|12}}
| style="text-align:right" | {{Nuclide|link=yes|Carbon|12}}
|- style="height:2em;"
| {{tl|ComplexNuclide}}
| <code><nowiki>{{ComplexNuclide|Carbon|12}}</nowiki></code>
| style="text-align:right" | {{ComplexNuclide|Carbon|12}}
| style="text-align:right" | {{ComplexNuclide|link=yes|Carbon|12}}
|- style="height:2em;"
| {{tl|ComplexNuclide}}
| <code><nowiki>{{ComplexNuclide|helium|2|anti=yes|charge=+}}</nowiki></code>
| style="text-align:right" | {{ComplexNuclide|helium|2|anti=yes|charge=+}}
| style="text-align:right" | {{ComplexNuclide|link=yes|helium|2|anti=yes|charge=+}}
|}

== Arguments ==
All the templates accept the same arguments.
{| class="wikitable"
|-
! 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.
|-
! {{para|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''”.
|-
! {{para|anti|yes}}
|| Specify the element is made of [[anti-matter]] and that the symbol should therefore be marked with an overline.
|-
! {{para|charge}}
|| Specify the charge of an [[ion]]ized atom.
|-
! {{para|q}}
|| Specify the quantity of the atom (useful in chemical formulas, only available in {{tl|ComplexNuclide}}).
|-
! m
|| Specifies that the atom is a [[nuclear isomer]].
|}

== Examples ==
:{| border = 0
|- style="height:2em;"
| <code><nowiki>{{SimpleNuclide|Carbon}}</nowiki></code> || {{SimpleNuclide|Carbon}}
|- style="height:2em;"
| <code><nowiki>{{SimpleNuclide|Carbon|14}}</nowiki></code> || {{SimpleNuclide|Carbon|14}}
|- style="height:2em;"
| <code><nowiki>{{SimpleNuclide|link=yes|Carbon}}</nowiki></code> || {{SimpleNuclide|link=yes|Carbon}}
|- style="height:2em;"
| <code><nowiki>{{SimpleNuclide|anti=yes|Carbon}}</nowiki></code> || {{SimpleNuclide|anti=yes|Carbon}}
|- style="height:2em;"
| <code><nowiki>{{SimpleNuclide|link=yes|Carbon|14}}</nowiki></code> || {{SimpleNuclide|link=yes|Carbon|14}}
|- style="height:2em;"
| <code><nowiki>{{SimpleNuclide|Carbon|12|m}}</nowiki></code> || {{SimpleNuclide|Carbon|12|m}}
|- style="height:2em;"
| <code><nowiki>{{ComplexNuclide|link=yes|anti=yes|Carbon|12|m|charge=2+}}</nowiki></code> || {{ComplexNuclide|link=yes|anti=yes|Carbon|12|m|charge=2+}}
|- style="height:2em;"
| <code><nowiki>{{ComplexNuclide|O|16|q=2}}</nowiki></code> || {{ComplexNuclide|O|16|q=2}}
|}
See [[User:SkyLined/List of nuclei]] for a list of all elements supported by these templates.

== Dependencies ==
* All of these templates use {{tl|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 {{tl|ProtonsForElement}} to get the element number for a given element.
* Some of these templates use {{tl|NeutronsForElement}} to get the default number of neutrons for a given element.
* Some of these templates use both {{tl|ProtonsForElement}} and {{tl|NeutronsForElement}} to get the default mass number for a given element.
* These templates use {{tl|LinkForElement}} to get the page to link to if the '''link=yes''' argument is used.
* These templates use {{tl|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:

{| border=0
|<nowiki>{{Nuclide |Blabla}}</nowiki> || {{Nuclide |Blabla |nocategory=true}}
|-
|<nowiki>{{Nuclide |Aluminum}}</nowiki> || {{Nuclide |Aluminum |nocategory=true}}
|-
|<nowiki>{{Nuclide |Element |link=yes}}</nowiki> || {{Nuclide |Element |link=yes |nocategory=true}}
|-
|}

==Tests==

* {{tl|Nuclide/overview E1-E54}}
* {{tl|Nuclide/overview E55-E119}}

Template:Nuclide templates/doc - Revision history

Admin: 1 revision imported

wikipedia>LaundryPizza03: /* Arguments */ grammar, linking