Template:Infobox isotopes (meta)
| Isotopes of (Xx) | |
|---|---|
Some attributes
| |
| First | Unknown |
| Second | Unknown |
| Third | Unknown |
Other attributes
| |
| Template documentation follows |
|---|
| Note: the template above may sometimes be partially or fully invisible. |
| Visit "Template:Infobox isotopes (meta)/doc" to edit its documentation if it is available. (How does this work?) |
Lua error in Module:TNT at line 159: Missing JsonConfig extension; Cannot load https://commons.wikimedia.org/wiki/Data:I18n/Uses TemplateStyles.tab. This is the meta template {{Infobox isotopes (meta)}} for the element isotopes-infoboxes (Category:Infobox element isotopes templates (1)). It replaced {{Infobox element isotopes}} (meta) 18 Mar 2023.
This infobox contains the table of § Main isotopes, and the § Standard atomic weight. For example, {{Infobox uranium isotopes}}, as used on page Isotopes of uranium.
The main isotopes table is reused in the regular Infobox: {{Infobox uranium}}.
Basic example
{{Infobox isotopes (meta)
|symbol =Ni
|ref-table =
|ref-nubase2020 =yes
|isotopes =
|footnote =
}}
| Isotopes of nickel (28Ni) | |
|---|---|
Some attributes
| |
| First | Unknown |
| Second | Unknown |
| Third | Unknown |
Other attributes
| |
{{Infobox isotopes (meta)
|symbol =Ni
|ref-table =<ref><nowiki>{{cite book|...}}</nowiki></ref>
|ref-nubase2020 =yes
|isotopes =
{{Isotopes/main/isotope |mn=58 |sym=Ni
|na=68.077% |hl=stable _link
}}
{{Isotopes/main/isotope |mn=59 |sym=Ni
|na=trace_link |hl={{val|7.6|e=4|u=y}}
|dm1=e _link |link1=cobalt-59 |pn1=59 |ps1=Co
}}
|footnote =Footnote here
|child ={{{child|no}}}
}}
parameters
{{Infobox isotopes (meta)
|symbol =
|ref-table =
|ref-nubase2020 =yes
|isotopes =
{{Isotopes/main/isotope|..}}
|footnote =Footnote here
|child ={{{child|no}}}
}}
|
|
Main isotopes table
The Main isotopes table is build by entering one template for each isotope-row.
{{Infobox isotopes (meta)
...
|isotopes =
{{Isotopes/main/isotope |link= |mn= |sym=
|na= |hl=
|ref=
|dm1= |perc1= |ref1= |link1= |pn1= |ps1=
|dm2= |perc2= |ref2= |link2= |pn2= |ps2=
}}
...
}}
The single-row parameters, commented
"!"=could be required;
..1–4 refer to the decay mode dm#=
{{Isotopes/main/isotope
|mn =! massnumber
|sym =! symbol
|link = isotope page: uranium-232
|ref = reference for the isotope-row
|na =! natural abundancy (can be: synth, trace)
|hl =! half-life (can be: stable)
|dm1 =! decay mode #1
|perc1 = % decay
|ref1 = reference for decay mode #1
|link1 = product isotope page
|pn1 =! product mass number
|ps1 =! product symbol
|dm2 = decay mode #2 etc.
|dm3 = decay mode #3 etc.
|dm4 = decay mode #4 etc.
}}
- For all code and formatted input: when not recognised, the input is shows as-is (unedited).
abundance, half-life trace, synthetic, stable by keyboard code
- Parameters
|na=,|hl=can handle simple keyboard code input. This simplifies typing:
|na=trace, synth,|hl=stable, obs stable.
|na=synth_linkwill link → synth- See also: percentage abundance, below.
- When not recognised, the input is shows as-is (unedited).
decay mode (β−β−) by keyboard code
- Decay modes
|dm1–4=can be entered as keyboard code:
|dm1=b+b+(instead of |dm1=β<sup>+</sup>β<sup>+</sup>), will show β+β+.
- Also, to wikilink:
|dm1=b+b+_link→ β+β+.
- When not recognised, the input is shows as-is (unedited).
- basic dm1–4 code rules
- α ←
a, β ←b, γ ←g, ε ←e
- Note: plain Latin letter
eused in "e+" only. (No confusion with "ee" for εε/ee).
- x+, x− ←
+ −(superscript = inline) - - − –
-(keyboard hyphen = minus) - A≠a: keep uppercase: SF ←
SF(sf)
percentage abundance, decay mode formatting
- Half-life time: usually
{{val}}to format|hl={{val|12.3|e=4|u=Ey}}}→12.3×104 Ey. Do not link the unit. - Percentage input
|na=,|perc1, perc2, perc3, perc4=
- No need for
{{val}}, plain "12.34%" will do. - The number willbe rounded to 3 sigfig.
- When dm-%
|perc1=0.003%, then formatted as "<0.01%". - When dm-%
|perc1=2.7e-12, then formatted as "≪0.01%".
- To evade this rule, use {{val}}:
|na={{val|0.9995|u=%}}(e.g., hydrogen)
- Do not add uncertainties "(5)" or "±0.3"
add reference
- USe dedicated reference parameters:
|ref-table=<ref>...in column header|ref-nubase2020=yes/noadds {{NUBASE2020}} in column header|ref=per isotope|ref=per decay mode
Do not add reference with input value: dm1=α<ref>..</ref>
Decay modes
| type rowid |
symbol (id) |
normalised code input |
names symbol wl enwiki NUBASE code-id |
A, Z | NUBASE, example, note |
|---|---|---|---|---|---|
dm-symbol
|
normal-codedm1−4
|
en-nameen-linknubase-name
|
AZ-changesaction-textqid
|
||
| 100 | alpha | ||||
dm 110
|
α |
|
|
• (A − 4, Z − 2) |
|
| 200 | beta | ||||
dm 210
|
β |
|
|
• ACTION:
|
|
dm 220
|
β− |
|
|
• (A, Z + 1) |
|
dm 230
|
β−β− 2β−
|
|
|
• (A, Z + 2) ACTION: A nucleus emits two electrons and two antineutrinos
|
|
dm 240
|
β+ ε + e+
|
|
|
• (A, Z − 1) ACTION: In NUBASE2020, β+ refers to the combined rate of electron capture (ε) and positron emission (e+): β+ = ε + e+
|
|
dm 250
|
β+β+ 2β+
|
|
|
• (A, Z − 2) ACTION: A nucleus emits two positrons and two neutrinos
|
|
| 300 | e, epsilon, gamma (internally, "epsi" is the code for char "ε"; "e" for Latn char "e" which occurs in "e+" only btw) | ||||
dm 310
|
ε |
|
|
• (A, Z − 1) ACTION: A nucleus captures an orbiting electron and emits a neutrino; the daughter nucleus is left in an excited unstable state
|
|
dm 320
|
εε |
|
|
• (A, Z − 2) ACTION:
|
|
dm 330
|
ε + β+ |
|
|
• ACTION: electron capture and β+ decay QID:
|
|
dm 340
|
e+ |
|
|
• (A, Z − 1) ACTION: A nuclear proton converts to a neutron by emitting a positron and an electron neutrino
|
|
dm 350
|
γ |
|
|
• ACTION:
|
|
| 400 | n, p | ||||
dm 410
|
n |
|
|
• (A − 1, Z) ACTION: A neutron ejected from nucleus
|
|
dm 420
|
2n |
|
|
• (A − 2, Z) ACTION: Two neutrons ejected from nucleus simultaneously
|
|
dm 430
|
p |
|
|
• (A − 1, Z − 1) ACTION: A proton ejected from nucleus
|
|
dm 440
|
2p |
|
|
• (A − 2, Z − 2) ACTION: Two protons ejected from nucleus simultaneously
|
|
| 500 | EC, IT, IS, SF, CD | ||||
dm 510
|
EC |
|
|
• (A, Z − 1) ACTION:
|
|
dm 520
|
IT |
|
|
• (A, Z) ACTION: A nucleus in a metastable state drops to a lower energy state by emitting a photon or ejecting an electron
|
|
dm 530
|
SF |
|
|
• variable ACTION: A nucleus disintegrates into two or more smaller nuclei and other particles, all of which may vary with each decay
|
|
dm 540
|
CD |
|
|
• (A − A1, Z − Z1) & (A1, Z1) ACTION: A nucleus emits a specific type of smaller nucleus (A1, Z1) which is larger than an alpha particle (e.g. 14C, 24Ne)
|
|
dm 550
|
IS |
|
|
• ACTION:
|
|
| 600 | delayed | ||||
dm 611
|
β−n |
|
|
• (A − 1, Z + 1) ACTION: A nucleus decays by β− emission to an excited state, which then emits a neutron
|
|
dm 612
|
β−2n |
|
|
• (A − 2, Z + 1) ACTION: A nucleus decays by β− emission to an excited state, which then emits two neutrons
|
|
dm 613
|
β−3n |
|
|
• (A − 3, Z + 1) ACTION: A nucleus decays by β− emission to an excited state, which then emits three neutrons
|
|
dm 614
|
β−α |
|
|
• (A − 4, Z − 1) ACTION: A nucleus decays by β− emission to an excited state, which then emits an α particle
|
|
dm 615
|
β−d |
|
|
• (A − 2, Z) ACTION: A nucleus decays by β− emission to an excited state, which then emits a deuteron
|
|
dm 616
|
β−t |
|
|
• (A − 3, Z) ACTION: A nucleus decays by β− emission to an excited state, which then emits a triton
|
|
dm 617
|
β−SF |
|
|
• β− & variable ACTION: A nucleus decays by β− emission to an excited state, which then undergoes spontaneous fission
|
|
dm 618
|
β+p |
|
|
• (A − 1, Z − 2) ACTION: A nucleus decays by β+ emission to an excited state, which then emits a proton
|
|
dm 619
|
β+2p |
|
|
• (A − 2, Z − 3) ACTION: A nucleus decays by β+ emission to an excited state, which then emits two protons
|
|
dm 621
|
β+3p |
|
|
• (A − 3, Z − 4) ACTION: A nucleus decays by β+ emission to an excited state, which then emits three protons
|
|
dm 622
|
β+α |
|
|
• (A − 4, Z − 3) ACTION: A nucleus decays by β+ emission to an excited state, which then emits an a particle
|
|
dm 623
|
β+SF |
|
|
• β+ & variable ACTION: A nucleus decays by β+ emission to an excited state, which then undergoes spontaneous fission
|
|
| 700 | 24Ne | ||||
dm 710
|
14C |
|
|
• ACTION:
|
|
dm 720
|
20Ne |
|
|
• ACTION:
|
|
dm 730
|
24Ne |
|
|
• ACTION:
|
|
dm 740
|
25Ne |
|
|
• ACTION:
|
|
dm 750
|
25Ne + 28Mg |
|
|
• ACTION:
|
|
dm 760
|
26Ne |
|
|
• ACTION:
|
|
dm 770
|
24Ne + 26Ne |
|
|
• ACTION:
|
|
dm 780
|
28Mg |
|
|
• ACTION:
|
|
dm 790
|
28Mg + 30Mg |
|
|
• ACTION:
|
|
dm 792
|
30Mg |
|
|
• ACTION:
|
|
dm 794
|
32Si |
|
|
• ACTION:
|
|
dm 796
|
34Si |
|
|
• ACTION:
|
|
| 800 | natural abundance, half-life (na, hl) | ||||
na 810
|
synth |
|
|
• ACTION:
|
|
na 820
|
trace |
|
|
• ACTION:
|
|
hl 850
|
stable |
|
|
• ACTION:
|
|
hl 860
|
observ. stable |
|
|
• ACTION:
|
|
| 900 | Not supported | ||||
dm 920
|
incorrect normal-code input: ≠ e- |
|
|
• ACTION: QID:
|
|
| 930 | IT ?
|
<dm> ? (theor) not implemented Decay mode is energetically allowed, but not experimentally observed |
• in NUBASE2020
| ||
| 940 | IT=?
|
<dm>=? (theor) not imp;lemented decay is observed, but its intensity is not experimentally known |
• in NUBASE2020
| ||
/isotope Full parameter list
{{Isotopes/main/isotope |link= |mn= |sym=
|na= |hl=
|ref=
|dm1= |perc1= |link1= |ref1= |pn1= |ps1=
|dm2= |perc2= |link2= |ref2= |pn2= |ps2=
|dm3= |perc3= |link3= |ref3= |pn3= |ps3=
|dm4= |perc4= |link4= |ref4= |pn4= |ps4=
}}
Standard atomic weight
The Infobox contains the table of Main Isotopes (more below), and the standard atomic weight (as published by CIAAW, see {{Infobox element/symbol-to-saw/CIAAW-saw-element-page}}.
what's new
- Mar 2023
- Main usually refers to Main isotopes (not mainspace, not main-article about ..)
|isobox ref=depr, repl|ref-table=, position=top table TODO check when child|ref-nubase2020=yes/no(aka|ref-NUBASE2020=) {{NUBASE2020}} named! ref tag! dflt
usage
This is the Infobox for an elements main isotopes. The meta-templatee is {{Infobox isotopes (meta)}} (META)
It contains a table of main isotopes and eventually the standard atomic weight.
This template is reused in {{Infobox <element>}} as a child Infobox (|child=yes).
As of Jan 2023[update], a 'Main isotope' is conforming MOS:MAINISOTOPE (under construction, see WP:ELEMENTS What is a "Main_isotope"?)
Each isotope has its own row, with decay modes:
ALL PARAMETERS
{{Infobox isotopes (meta)
|symbol =
|ref-table =
|ref-nubase2020=<!-- yes/no -->
|ref-NUBASE2020=<!-- aka -->
|isotopes =
{{Isotopes/main/isotope
|link= |mn= |sym=
|na= |hl=
|ref=
|dm1= |perc1= |link1= |ref1= |pn1= |ps1=
|dm2= |perc2= |link2= |ref2= |pn2= |ps2=
|dm3= |perc3= |link3= |ref3= |pn3= |ps3=
|dm4= |perc4= |link4= |ref4= |pn4= |ps4= }}
|footnote =
|child ={{{child|no}}}<!-- [IB element] -->
}}
- Table used in {{Infobox element}}
Isotope decay example
| Isotopes of () | |
|---|---|
Some attributes
| |
| First | Unknown |
| Second | Unknown |
| Third | Unknown |
Other attributes
| |
{{Infobox isotopes (meta)
|symbol=
|isotopes=
{{Isotopes/main/isotope |sym=U |mn=234
|na=95% |hl=2 y
|ref=<ref>Reference A</ref>
|dm1=α |ps1=Cn |pn1=247
|dm2=β |perc2=0.001% |ref2=<ref>Reference decay-2 </ref>|ps2=Pu |pn2=242 }}
{{Isotopes/main/isotope |sym=U |mn=234
|na=95% |hl=2 y
|ref=<ref>Reference A</ref>
|dm1=α |ps1=Cn |pn1=247
|dm2=β |perc2=0.001% |ref2=<ref>Reference decay-2 </ref>|ps2=Pu |pn2=242 }}
}}
- more parameters used
| Isotopes of () | |
|---|---|
Some attributes
| |
| First | Unknown |
| Second | Unknown |
| Third | Unknown |
Other attributes
| |
{{Isotopes/main/isotope |sym=U |mn=234
|na=trace_link |hl=2 y
|ref=<ref>Reference A</ref>
|dm1=α |perc1=95% |link1=Cn-247 |ps1=Cn |pn1=247
|dm2=β |perc2=0.005% |link2=plutonium-242 |ps2=Pu |pn2=242 }}
{{Infobox isotopes (meta)
|isotopes=
{{Isotopes/main/isotope
|link= |sym= |mn=
|na= |hl=
|ref=
|dm1= |perc1= |link1= |ps1= |pn1=
|dm2= |perc2= |link2= |ps2= |pn2=
|dm3= |perc3= |link3= |ps3= |pn3= }}
}}
Standard atomic weight
For stable elements, the formal standard atomic weight (s.a.w.) is added, as published by CIAAW. When the s.a.w. is in interval-notation, its conventional value is added too. Data is retrieved from central s.a.w. values lists, formatting is by {{Infobox element/standard atomic weight format}} (same as {{infobox element}}). Example:
| Isotopes of lithium (3Li) | |
|---|---|
Some attributes
| |
| First | Unknown |
| Second | Unknown |
| Third | Unknown |
Other attributes
| |
{{Infobox isotopes (meta)
|symbol=Li
}}
Tracking
References
- ↑ {{cite book|...}}
- ↑ 2.0 2.1 Kondev, F. G.; Wang, M.; Huang, W. J.; Naimi, S.; Audi, G. (2021). "The NUBASE2020 evaluation of nuclear properties" (PDF). Chinese Physics C. 45 (3) 030001. doi:10.1088/1674-1137/abddae.
- ↑ Reference A
- ↑ cite book: Hello World
- ↑ Reference A
See also
- {{Isotopes summary}} -- in-article table, esp SHE. See copernicium.
- {{Infobox element}} -- shows this template by element.
- Category:Infobox element isotopes templates (1)
- {{Infobox element/element navigation}} -- additional documentation (top left boxes)
Isotope templates overview |
|---|
- Template:Infobox isotopes (meta) invokes Module:Navbox using Lua.
Usage
This template can be used to make a standard navigation box. It is intended for use within another template that standardises the title and contents of the box (see Template:ShipNavbox). This template SHOULD NOT be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.
The purpose of this template is to standardise the attributes of all navigation boxes, for example, their colours and other CSS attributes. The template is fairly simple, and could be extended to add other features in the future. Using this template allows changes to be implemented much quicker and easier than editing each template separately.
Syntax
{{navbox
|state = uncollapsed, collapsed, plain, autocollapse (default)
|name = mandatory - name of the template
|style = optional - style for the whole table
|title = mandatory - navbox header
|gtitleN = optional - title of N-th group of items
|styleN = optional - style for groupN; i.e. text-align
|groupN = mandatory - list of groups of items
|fstyle = optional - style for footer ; i.e. text-align
|footer = optional - navbox footer
}}
- Groups: Currently there is no technical limit to the maximum number of groups.
- Groups of items can be added as parameters: group1, group2, group3, ... up to groupN.
- Group title: Each group has its own title parameter: gtitle1, gtitle2, gtitle3, ... up to gtitleN. Note that the default width for the first column is 15%.
- Group style: Style may also be customised to each group in: style1, style2, style3, ... up to styleN.
- Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
- Line breaks: Line-breaks (
<br />) are unnecessary, as text wrapping is done automatically by the template. This also includes links and text in gtitleN and groupN. - Bullets: Create unordered lists with lines beginning with *.
- Pipe links: Because of the nature of template syntax, it may be necessary to use Template:! (
{{!}}).
States
- Autocollapse: By default, the state of a navbox is "autocollapsed". This means that if the number of navboxes in a page exceeds the maximum allocation of the collapsible navboxes, then the remaining navboxes are collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
- Currently, the autocollapse allocation is 2 (see MediaWiki:Common.js). This means that if there are 3 navboxes in a page, the third and subsequent navboxes will be collapsed automatically.
- Uncollapsed: Forces the navbox to be displayed.
- All of the navboxes in this documentation are in the uncollapsed state.
- Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
- Navboxes with a height of more than 300 pixels will also be collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
- Plain: Removes the "show/hide" link.
Sub-groups
- For larger navboxes, it may be necessary to include sub-groups within a particular group of items. It is also possible to collapsible navboxes within the parent navbox, see Collapsible sub-groups.
- To create sub-groups within
{{navbox}}, certain parameters are to be included:- The parent navbox group (i.e. group2 in the example below) requires the type parameter (gtype2 = Subgroup).
- The nested navbox (sub-group) requires the inclusion of the sub-group parameter (subgroup = yes). This enables the template to differentiate between the sub-group and the parent navbox.
{{navbox
|name =
|title =
|gtitle1 =
|group1 =
|gtitle2 =
|gtype2 = Subgroup (mandatory)
|group2 =
{{navbox
|subgroup = yes (mandatory)
|gtitle1 =
|group1 =
|gtitle2 =
|group2 =
}}
}}
Collapsible sub-groups
- For extremely long navboxes, it is recommended to use collapsible navboxes within the parent navbox. Further sub-groups can then be added to these collapsible navboxes.
- To create collapsible sub-groups within
{{navbox}}, these parameters need to be included:- The parent navbox is almost always uncollapsed (state=uncollapsed).
- The parent navbox group (i.e. group1 in the example below) requires the type parameter (gtype1 = Subgroup).
- The nested collapsible navbox requires the inclusion of the collapsible parameter (collapsible = yes). This enables the template to differentiate between the collapsible navbox and the parent navbox.
- The nested collapsible navbox is forcefully collapsed (state=collapsed).
{{navbox
|state = uncollapsed
|name =
|gtype1 = Subgroup
|group1 =
{{navbox
|collapsible = yes
|state = collapsed
|title =
|gtitle1 =
|group1 =
|gtitle2 =
|group2 =
}}
}}
Use of images
- The use of images in navboxes is permitted, but please resize the images to keep them small. Inventory-sized images (25-30 pixels) are recommended.
- Please use {{t|plink}} to create links with images. Use {{t|plink}} for any case where text is not desired after the link. It functions the same as {{t|plink}}, but it does not produce a wikilink in text. Use {{t|chatl}} to link chatheads. These templates create links for both the image and text (except for {{t|plink}}) using far less wikicode than the standard syntax.
Link and file share the same name
{{plink|Item}}
File name differs from the link
{{plink|Item|File}}
Link and file share the same name, but different text is desired to display
{{plink|Item|alt=Text}}
File name differs from the link and different text is desired to display
{{plink|Item|File|alt=Text}}
Categorising
Navboxes are very useful for transcluding categories onto a large number of pages that share both a trait and the navigation box. For example: Template:ShipNavbox transcludes Category:Ships onto every page that uses it.
There are 2 methods of categorising pages with navboxes:
The first way is with {{t|Ctg}}. This is the preferred method, and can be used in most cases. The rules and operations for the Category handler template are very simple; however, they are enough to produce the desired results on most pages.
Categorisation should only be used on a template for large-scale addition. It is unhelpful, for example, to use a rule that only applies to 1 page.
Examples
To see the following navboxes in action, see Template:Navbox.
Single line navbox with centered list
{{navbox
|name =
|title =
|style1 = text-align:center
|group1 =
}}
Navbox with standard footer
{{navbox
|name =
|title =
|gtitle1 =
|group1 =
|footer = Centered footer
}}
Navbox with styled footer
{{navbox
|name =
|title =
|gtitle1 =
|group1 =
|fstyle = text-align:right
|footer = Right-aligned footer
}}
Multiple line navbox
{{navbox
|name =
|title =
|gtitle1 = Group title 1
|group1 =
|gtitle2 = Group title 2
|group2 =
|gtitle3 = Group title 3
|group3 =
}}
Collapsed navbox
{{navbox
|state = collapsed
|name =
|title =
|style1 = text-align:center
|group1 =
}}
Plain navbox with Tnavbar
{{navbox
|state = plain
|name =
|title =
|style1 = text-align:center
|group1 =
}}
Plain navbox without Tnavbar
{{navbox
|state = plain
|title =
|style1 = text-align:center
|group1 =
}}
Complicated navbox
{{navbox
|state = uncollapsed
|name =
|title =
|gtitle1 = Level 1 Title 1
|group1 =
|gtitle2 = Level 1 Title 2
|group2 =
|gtitle3 = Level 1 Title 3
|group3 =
|gtitle4 = Level 1 Title 4
|group4 =
|gtitle5 = Level 1 Title 5
|gtype5 = Subgroup
|group5 =
{{navbox
|subgroup = Yes
|gtitle1 = Level 2 Title 1
|group1 =
|gtitle2 = Level 2 Title 2
|group2 =
|gtitle3 = Level 2 Title 3
|gtype3 = Subgroup
|group3 =
{{navbox
|subgroup = Yes
|gtitle1 = Level 3 Title 1
|group1 =
|gtitle2 = Level 3 Title 2
|group2 =
}}
|gtitle4 = Level 2 Title 4
|group4 =
}}
|gtitle6 = Level 1 Title 6
|group6 =
|gtitle7 = Level 1 Title 7
|group7 =
|fstyle =
|footer =
}}
Preventing unwanted documentation
The Navbox template's documentation is automatically transcluded under the navbox on any Template namespace page. It is not transcluded when used as a sub-group or collapsible sub-group template (subgroup= yes or collapsible=yes).
Should the documentation appear when it is unwanted, it can be hidden by setting the doc parameter doc=no on the template. In most cases, the doc parameter is NOT used and the parameter is removed completely.