View source for Template:Isotopes table/doc

{{documentation subpage}}
This template contains the '''table header''' and '''table footer''' of the large isotopes table (ca. 12 columns. See for example {{slink|Isotopes_of_uranium|List_of_isotopes}}). The individual ''rows'' (one for each isotope) are not by template.

== Usage ==
The template provides a '''standardised table header''' for a <code>List of isotopes</code>, as is used in each of the 118 [[:Category:Lists of isotopes by element|Isotopes of &lt;element&gt;]] articles. Parameters allow for adjustment of the table header structure, references and table footnotes. This header does ''not'' change existing rows: values, isotope-specific footnotes, structure, nor split decay routes {{{{as of|2019-06|lc=y}}}}.

The parameters are
:{{para|symbol}} William do various settings, including appropriate natural abundance column headers
:{{para|refs}} will add an inline reference(s) for any 2016 data update. E.g., {{tlf|NUBASE2016}}
:{{para|notes}} will add multiple footnotes, mostly notational clarifications (like for "<sup>m</sup>", "SF"), and optional column headers like "Historical name"

The table is closed by adding <code>{{tlf|Isotopes table/footer}}</code>.
General appearance in source:
<syntaxhighlight lang="wikitext">
{{Isotopes table
|symbol=He
|refs=NUBASE2016, AME2016 II
|notes=histname, mass#, daughter-nst, CD, SF
}}
|-
| <!-- (table row with single isotope) -->
|
|
|-
| <!-- (table row with single isotope) -->
|
|
{{Isotopes table/footer}}
</syntaxhighlight>

===Parameter options (quick list)===
*{{para|symbol|H, He, ..., Og}}: per article title, required
*{{para|refs|NUBASE2020, NUBASE2016, AME2020 II, AME2016 II, CIAAW2016abundance}}: inline references
*{{para|notes|m, histname, resonance, unc(), mass#, exen#, hl#, spin#, spin(), hl-nst, daughter-st, daughter-nst, var[], CD, EC, IT, SF, n, p}}

==Parameter options==
===References: NUBASE, AME, CIAAW===
{{para|refs|NUBASE2016, NUBASE2020, AME2016 II, AME2020 II, CIAAW2016abundance}}: adds inline references on data sources
;Notes
:{{para|refs|AME2020 I}} (the research paper) is not implemented in this table. Request can be made at [[WT:ELEMENTS]]). 
{{Isotopes table|symbol=U|refs=NUBASE2016, AME2016 II, CIAAW2016abundance}}
|-
{{Isotopes table/footer}}

*{{para|refs|NUBASE2020}} adds {{tlx|NUBASE2020}} with &lt;ref name="NUBASE2020">:
::{{NUBASE2020}}

*{{para|refs|NUBASE2016}} adds {{tlx|NUBASE2016}} with &lt;ref name="NUBASE2016">:
::{{NUBASE2016}}

*{{para|refs|AME2020 II}} adds {{tlx|AME2020 II}} with &lt;ref name="AME2016 II">:
::{{AME2020 II}}

*{{para|refs|AME2016 II}} adds {{tlx|AME2016 II}} with &lt;ref name="AME2016 II">:
::{{AME2016 II}}

*{{para|refs|CIAAW2016abundance}} adds {{tlx|CIAAW2016abundance}} with &lt;ref name="CIAAW2016abundance">:
::{{CIAAW2016abundance|plain}}

More references in [[#References overview|§ References overview]].

===Column and row variants===
{{Isotopes table|symbol=Xx|doc=yes}}
{{Isotopes table/footer}}
<span style="background:lightgreen">These header options</span> are set by {{para|notes|}}:
* + '''Historic name''' column:
::''opt-in'' by setting {{para|notes|histname}} (some 11 elements, {{as of|2019|June|lc=y}})<!-- Ac, Bi, Fr, Pb, Po, Pr, Ra, Rn, Tl, Th, U -->
* + '''Excitation energy''' data, in eV: the isotope row has a 2nd row with <sup>m</sup>Xx isotope
::''opt-in'' by setting {{para|notes|m}} (some 100 elements)
* + '''<nowiki>[resonance width]</nowiki>''' wikilink added in header Half-life:
::''opt-in'' by setting {{para|notes|resonance}} (some 10 elements)<!-- B, H, Be, missing, so to be added after June 2019: C, Li, F, He, Ne, N, O -->
* + '''Note''' column, free text:
::''opt-in'' by setting {{para|notes|note}}

<span style="background:yellow">These columns</span> are added per {{para|symbol|}}:
* + '''Natural abundance''' (only traces in nature):
::''opt-in''  {{code|1=Tc, Pm, Po, At, Rn, Fr, Ra, Ac, Np, Pu}} (10x, {{as of|2019|June|lc=y}}) (list maintained [[Template:Isotopes table|here]])
* + '''Natural abundance''' 2 columns: abundance in nature, and range of variation: 
::''opt-out'' {{Code|1=Am, Cm, Bk, Cf, Es, Fm, Md, No, Lr, Rf, Db, Sg, Bh, Hs, Mt, Ds, Rg, Cn, Nh, Fl, Mc, Lv, Ts, Og}} (24x, same list)
::''and'' ({{as of|2019|June|lc=y}}) (list maintained [[Template:Isotopes table|here]])

===Table footnotes===
<syntaxhighlight lang="wikitext">|notes=histname, resonance,
m, mass#, unc(), hl#, spin#, exen#, hl-nst, daughter-nst, daughter-st, spin(), var[]
CD, EC, IT, SF, n, p
</syntaxhighlight>
The input order is not relevant. Sequence shown is the order of appearance in the header (so <sup>m</sup> lists first, spin() last).

Illustrating the column an option it relates to:
{{Isotopes table
|symbol=Xx
|notes=histname, resonance,
m, mass#, unc(), hl#, spin#, exen#, hl-nst, daughter-nst, daughter-st, spin(), var[]
CD, EC, IT, SF, n, p
|test=no}}
|-
|{{para|refs|NUBASE2016}}
|
|
|
|<code>AME2016 II</code>
|
|
|
|
|<code>CIAAW2016abundance</code>
|
|-
| {{para|notes|m}}
| <code>histname</code>
| <code>exen#</code>
|
| <code>unc(), mass#</code>
| <code>resonance,</code><br/><code>hl#, hl-nst</code>
| <code>CD, EC, IT, SF, n, p</code>
| <code>daughter-nst,</code><br/><code>daughter-st</code>
| <code>spin(), spin#</code>
| 
| <code>var[]</code>
{{Isotopes table/footer}}

===Footnote texts===
{{Isotopes table/ref_group/doc}}

===In-row footnotes===
In-row footnotes for individual isotopes can be added like:
:<code><sup>266</sup>Hs&lt;ref group=n>Not directly synthesized, occurs as [[decay product]] of <sup>270</sup>Ds&lt;/ref></code> &rarr;
:<sup>266</sup>Hs<ref group=n>Not directly synthesized, occurs as decay product of <sup>270</sup>Ds</ref>
<references group="n" />

It is also possible to add a Notes column, and write the remark directly in a cell.

{{para|notes|note}}
<syntaxhighlight lang="wikitext">
|-
|<sup>266</sup>Hs
|
...
|
| Not directly synthesized, occurs as decay product of <sup>270</sup>Ds
</syntaxhighlight>

==Template Data==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"test": {},
		"symbol": {
			"example": "Hg",
			"type": "string",
			"required": true
		},
		"notes": {
			"example": "m, histname, resonance, unc(), mass#, exen#, hl#, spin#, spin(), hl-nst, daughter-st, daughter-nst, var[], CD, EC, IT, SF, n, p"
		},
		"refs": {
			"description": "NUBASE2016, AME2016 II, CIAAW2016abundance"
		},
		"doc": {}
	},
	"description": "Adds a header to the List of isotopes",
	"paramOrder": [
		"symbol",
		"refs",
		"notes",
		"doc",
		"test"
	],
	"format": "block"
}
</templatedata>

==Documentation parameters==
Two parameters are available for documentation:
* {{para|test|yes}} will show the parameter input (feedback)
* {{para|doc|yes}} shows colored columnheaders as used in [[#Column and row variants]]

==Todo==
* Provide option to add hardcoded references in header (next to predefined "{{para|ref|NUBASE2020}}" code).

==See also==
===References overview===
{{Isotopes table/references|expand=yes}}

===Subtemplates and tests===
:[[Wikipedia_talk:WikiProject_Elements#Header_template_available|WT:ELEM talk]]
* {{t links|Isotopes table}}
* {{t links|Isotopes table/header}}
*: {{t links|Isotopes table/header/col_HistName}}
*: {{t links|Isotopes table/header/cols_AbuNaturalVar}}
*: {{t links|Isotopes table/header/col_Note}}
*: {{t links|Isotopes table/header/row2_ExEn}}
* {{t links|Isotopes table/footer}}
:: {{t links|Isotopes table/references}}
* {{t links|Isotopes table/ref_group}} -- footnotes
:: {{t links|Isotopes table/ref_group/doc}} -- list of footnote options ({{para|notes|m, ..., spin()}})
:: {{t links|Isotopes table/ref_group/table}} -- builds a wikitable for decay modes, no textual settings
* '''Tests''': [[Template:Isotopes table/testcases|/testcases]] (items), [[Template:Isotopes table/testcases2|/testcases2]] (example elements)

===Index===
{{Index to chemical element pages/isotopes-of pages inline}}
{{Navbox element isotopes}}
<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Periodic table templates]]

}}</includeonly>

==References==
{{Reflist}}