Difference between revisions of "Template:Chem/doc"
imported>DePiep |
imported>Christian75 |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{COinS safe|n}} | {{COinS safe|n}} | ||
| − | This template allows you to render chemical | + | This template allows you to render chemical formulas using HTML. Alternatively, you can use {{tag|chem}}, using [[Help:Displaying_a_formula#Chemistry|mhchem LaTeX]] notation to generate formulas. |
<div style="clear: both;"></div> | <div style="clear: both;"></div> | ||
==Template instructions== | ==Template instructions== | ||
| − | This template, {{Tl|chem}}, serves to simplify the writing of chemical | + | This template, {{Tl|chem}}, serves to simplify the writing of chemical formulas. For example, |
<pre> | <pre> | ||
{{chem|H|2|O}} | {{chem|H|2|O}} | ||
| Line 74: | Line 74: | ||
*To include "=" in the formula, use "&#61;" For example, "<nowiki>{{chem|CH|2|&#61;CH|2}}</nowiki>" yields {{chem|CH|2|=CH|2}}.<!-- AWKWARD, ISN'T IT? --> | *To include "=" in the formula, use "&#61;" For example, "<nowiki>{{chem|CH|2|&#61;CH|2}}</nowiki>" yields {{chem|CH|2|=CH|2}}.<!-- AWKWARD, ISN'T IT? --> | ||
**Or, don't use this template. For example, "<nowiki>CH<sub>2</sub>=CH<sub>2</sub></nowiki>" yields CH<sub>2</sub>=CH<sub>2</sub>. | **Or, don't use this template. For example, "<nowiki>CH<sub>2</sub>=CH<sub>2</sub></nowiki>" yields CH<sub>2</sub>=CH<sub>2</sub>. | ||
| − | *To include "≡" in the formula, use "≡" For example, "<nowiki>{{chem|HC&#8801;CH}}</nowiki>" yields {{chem|HC≡CH}}.<!-- AWKWARD, ISN'T IT? --> | + | *To include "≡" in the formula, use "&#8801;" For example, "<nowiki>{{chem|HC&#8801;CH}}</nowiki>" yields {{chem|HC≡CH}}.<!-- AWKWARD, ISN'T IT? --> |
*The template accepts up to twenty parameters in addition to <code>link</code>. | *The template accepts up to twenty parameters in addition to <code>link</code>. | ||
*This template uses {{tl|su}}. | *This template uses {{tl|su}}. | ||
| Line 85: | Line 85: | ||
== TemplateData == | == TemplateData == | ||
{{TemplateData header}} | {{TemplateData header}} | ||
| + | {{collapse top|title=Template data|bg=#ccc}} | ||
<templatedata> | <templatedata> | ||
{ | { | ||
"params": { | "params": { | ||
| + | "1": {}, | ||
| + | "2": {}, | ||
| + | "3": {}, | ||
| + | "4": {}, | ||
| + | "5": {}, | ||
| + | "6": {}, | ||
| + | "7": {}, | ||
| + | "8": {}, | ||
| + | "9": {}, | ||
| + | "10": {}, | ||
| + | "11": {}, | ||
| + | "12": {}, | ||
| + | "13": {}, | ||
| + | "14": {}, | ||
| + | "15": {}, | ||
| + | "16": {}, | ||
| + | "17": {}, | ||
| + | "18": {}, | ||
| + | "19": {}, | ||
| + | "20": {}, | ||
| + | "21": {}, | ||
| + | "22": {}, | ||
| + | "23": {}, | ||
| + | "24": {}, | ||
"link": { | "link": { | ||
"label": "Link", | "label": "Link", | ||
| Line 95: | Line 120: | ||
} | } | ||
}, | }, | ||
| − | "description": "Render chemical | + | "description": "Render chemical formulas using HTML. Alternatively, you can use <chem>...</chem>, using mhchem LaTeX notation to generate formulas.\n\nUp to 25 unnamed ordered parameters can be used with automatic detection of subscripts and superscripts.", |
| − | "format": "inline" | + | "format": "inline", |
| + | "paramOrder": [ | ||
| + | "link", | ||
| + | "1", | ||
| + | "2", | ||
| + | "3", | ||
| + | "4", | ||
| + | "5", | ||
| + | "6", | ||
| + | "7", | ||
| + | "8", | ||
| + | "9", | ||
| + | "10", | ||
| + | "11", | ||
| + | "12", | ||
| + | "13", | ||
| + | "14", | ||
| + | "15", | ||
| + | "16", | ||
| + | "17", | ||
| + | "18", | ||
| + | "19", | ||
| + | "20", | ||
| + | "21", | ||
| + | "22", | ||
| + | "23", | ||
| + | "24" | ||
| + | ] | ||
} | } | ||
</templatedata> | </templatedata> | ||
| − | + | {{collapse bottom}} | |
<includeonly>{{sandbox other|| | <includeonly>{{sandbox other|| | ||
[[Category:Text-specific formatting and function templates]] | [[Category:Text-specific formatting and function templates]] | ||
| − | + | [[Category:Chemistry formatting and function templates]] | |
| − | [[Category:Chemistry templates]] | ||
[[Category:Superscript and subscript templates]] | [[Category:Superscript and subscript templates]] | ||
}}</includeonly> | }}</includeonly> | ||
Latest revision as of 22:35, 19 February 2020
| 40px | This is a documentation subpage for Template:Chem. It contains usage information, categories and other content that is not part of the original template page. |
| Notice | This template should not be used in citation templates such as Citation Style 1 and Citation Style 2, because it includes markup that will pollute the COinS metadata they produce; see Wikipedia:COinS. |
This template allows you to render chemical formulas using HTML. Alternatively, you can use <chem>...</chem>, using mhchem LaTeX notation to generate formulas.
Contents
Template instructions
This template, {{chem}}, serves to simplify the writing of chemical formulas. For example,
{{chem|H|2|O}}
will yield:
- H
2O
Algebraic expression as subscript
Algebraic expressions are rendered as subscripts (but must not contain upper case letters).
{{chem|C|''n''|H|2''n'' + 2}}
gives
- C
nH
2n + 2
Charge
Ion charge superscripts (for: +/-) are also supported:
{{chem|H|3|O|+}}
yields a "+" as superscript:
- H
3O+
Simultaneous subscripts/superscripts are automatically handled (use a hyphen for the minus sign):
{{chem|SO|4|2-}}
gives "2-" as superscript:
- SO2−
4
The hyphen is converted to a true minus sign.
Atomic number and mass number
The first parameter can be used for mass number.
{{chem|4|He}}
gives:
- 4
He
The first two parameters can be used for mass number and atomic number.
{{chem|4|2|He}}
gives:
- 4
2He
- Note
- Only the first two parameters can handle two consecutive plain numbers (i.e. without a plus sign or a hyphen (
+or-) following). Otherwise the template will loop.
- See also {{Nuclide2}}
Linking
The optional parameter link changes the formula into a link. For example:
{{chem|link=water|H|2|O}}
will yield:
Individual elements can be linked in the following manner:
{{chem|[[Hydrogen|H]]|2|[[Oxygen|O]]}}
gives
Notes
- To include "=" in the formula, use "=" For example, "{{chem|CH|2|=CH|2}}" yields CH
2=CH
2.- Or, don't use this template. For example, "CH<sub>2</sub>=CH<sub>2</sub>" yields CH2=CH2.
- To include "≡" in the formula, use "≡" For example, "{{chem|HC≡CH}}" yields HC≡CH.
- The template accepts up to twenty parameters in addition to
link. - This template uses {{su}}.
See also
- {{Chemical formula}}, which auto-links elements and common compounds
- {{Chem2}}
- {{Chem molar mass}}
TemplateData
TemplateData for Chem
Template data
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Render chemical formulas using HTML. Alternatively, you can use <chem>...</chem>, using mhchem LaTeX notation to generate formulas. Up to 25 unnamed ordered parameters can be used with automatic detection of subscripts and superscripts.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||