Template:Chembox

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

Usage

Copy the template from one of the forms below into the top of the document, and add data to the fields. Don't worry about trying to fill in all the fields -- even if you can only get the basics, that can still be very useful.

General:

• Do not delete fields that you don't know the data for, empty fields will just not give a row in the result, and sections without data will also not show up. Other editors may just fill in the fields that are empty. You can delete sections which are not applicable for the compound (see extra sections/fields).

• Do not {{subst}} this template, empty fields will not show up, and when formatting changes are applied to the template, it will not be visible in all documents transcluding the Chembox. The substituted template is an unintelligible gibberish of esoteric template code, and certain parts will not transclude. Keeping it un-subst-ed makes placing the data even more easy, and saves a lot of space on a page (the unsubsted Chembox is on an average page about 1000 bytes smaller than a fully transcluded Chembox).

• For the sub-box supplement to show up, the supplementary page "pagename (data page)" has to be available. When the Chembox grows too big, consider starting a datapage and move data from the Chembox into that page.

• For alt text, please see Wikipedia:Alternative text for images, particularly its Chemistry section.

Getting a Chembox

The Chemboxes have a more or less modular design. They are built up out of several sections, and depending on the compound, certain sections can be removed, or other sections can be added.

If the box needs expansion from another field, simply copy the section from the full template form, and paste it into the Chembox (make sure that each section has its own number, note that a section starts with "| section# = {{Chembox " and ends with "}}"; make sure the sections don't 'nest'). There are 15 sections available (though only 8 have been defined so far).

The order of section numbers does effect the actual order in the final document. If a chemical compound would e.g. both be an explosive and a drug, but the drug properties are more important, consider giving the drug-section a lower sectionnumber than the explosive-section, and the drug-section will appear above the explosive-section. The actual numbering of the sections does not matter (as long as the numbers are in the range 1–15) as long as no duplicate sections are defined.

Available subst templates (type {{subst:Chembox subst}} in the document and press save to get the empty box):

• {{Chembox subst}} or {{Chembox subst small}} for standard chemicals
• {{Chembox subst medium}}, a bit more information
• {{Chembox subst full}} or {{Chembox subst large}}, a complete list

Specialised:

• {{Chembox subst drug}}, a medium box with the pharma box
• {{Chembox subst explosive}}, a medium box with the explosive box

Small/simple form

To use, simply copy and paste the left column into the document, filling in whatever you can, or type {{subst:Chembox subst small}} and press save:

{{Chembox | ImageFile = | ImageSize = | ImageAlt = | IUPACName = | OtherNames = | Section1 = {{Chembox Identifiers | CASNo = | PubChem = | SMILES = }} | Section2 = {{Chembox Properties | Formula = | MolarMass = | Appearance = | Density = | MeltingPt = | BoilingPt = | Solubility = }} | Section3 = {{Chembox Hazards | MainHazards = | FlashPt = | Autoignition = }} }}

Full form

To use, simply copy and paste the left column into the document, or type {{subst:Chembox subst full}} and press save to get an empty Chembox:

{{Chembox | Name = | ImageFile = | ImageSize = | ImageAlt = | ImageCaption = | ImageFile1 = | ImageSize1 = | ImageAlt1 = | ImageCaption1 = | ImageFile2 = | ImageSize2 = | ImageAlt2 = | ImageCaption2 = | ImageFile3 = | ImageSize3 = | ImageAlt3 = | ImageCaption3 = | ImageFile4 = | ImageSize4 = | ImageAlt4 = | ImageCaption4 = | ImageFileL1 = | ImageSizeL1 = | ImageAltL1 = | ImageCaptionL1 = | ImageFileR1 = | ImageSizeR1 = | ImageAltR1 = | ImageCaptionR1 = | ImageFileL2 = | ImageSizeL2 = | ImageAltL2 = | ImageCaptionL2 = | ImageFileR2 = | ImageSizeR2 = | ImageAltR2 = | ImageCaptionR2 = | IUPACName = | IUPACName_hidden = yes | SystematicName = | OtherNames = | Section1 = {{Chembox Identifiers | Abbreviations = | CASNo = | CASNo_Comment = | CASNo_Ref = | CASNos = | CASOther = | PubChem = | PubChem_Comment = | PubChem5 = | PubChem5_Comment = | PubChemOther = | ChemSpiderID = | ChemSpiderID_Comment = | ChemSpiderID5 = | ChemSpiderIDOther = | EINECS = | EC-number = | EINECSCASNO = | UNNumber = | DrugBank = | KEGG = | MeSHName = | ChEBI = | RTECS = | ATCvet = | ATCCode_prefix = | ATCCode_suffix = | ATC_Supplemental = | SMILES = | InChI = | Beilstein = | Gmelin = | 3DMet = }} | Section2 = {{Chembox Properties | Formula = | MolarMass = | Appearance = | Density = | MeltingPt = | Melting_notes = | BoilingPt = | Boiling_notes = | LogP = | VaporPressure = | HenryConstant = | AtmosphericOHRateConstant = | pKa = | pKb = | Solubility = | SolubleOther = | Solvent = | Sheet Resistance = | Methacrylate Equiv Wt = | Bulk Conductivity = }} | Section3 = {{Chembox Structure | CrystalStruct = | Coordination = | MolShape = }} | Section4 = {{Chembox Thermochemistry | DeltaHc = | DeltaHf = | Entropy = | HeatCapacity = }} | Section5 = {{Chembox Pharmacology | AdminRoutes = | Bioavail = | Metabolism = | HalfLife = | ProteinBound = | Excretion = | Legal_status = | Legal_US = | Legal_UK = | Legal_AU = | Legal_CA = | PregCat = | PregCat_AU = | PregCat_US = }} | Section6 = {{Chembox Explosive | ShockSens = | FrictionSens = | ExplosiveV = | REFactor = }} | Section7 = {{Chembox Hazards | ExternalMSDS = | EUClass = | EUIndex = | MainHazards = | NFPA-H = | NFPA-F = | NFPA-R = | NFPA-O = | RPhrases = | SPhrases = | RSPhrases = | FlashPt = | Autoignition = | ExploLimits = | LD50 = | PEL = }} | Section8 = {{Chembox Related | OtherAnions = | OtherCations = | OtherFunctn = | Function = | OtherCpds = }} }}

Chembox: Template name * Name: title above the box (DEFAULT: article name) * filename.svg ('''not''' [[image:filename.svg]] * picture size (example: ImageSize=100px, default=200px) * alt text for picture (example: Fine dry white powder) * Picture caption (example: Oxygen in liquid form) * the IUPAC name * hide IUPAC name if very long; show-button is displayed * the systematic name * any other name '''Section Identifiers:''' Standard numbers etc. * any abbreviations * CAS Number: links to eMolecules http://www.commonchemistry.org/ * PubChem: links to http://pubchem.ncbi.nlm.nih.gov; up to 5 numbers * PubChem_Comment: comment at the number * PubChemOther: for other information * ChemSpider: links to www.chemspider.com; up to 5 numbers * EINECS: links to ecb; URL is http://ecb.jrc.it/esis/index.php?GENRE=ECNO&ENTREE= * also EINECS, but URL is http://ecb.jrc.it/esis/index.php?GENRE=CASNO&ENTREE= * KEGG: links to genome.ad.jp * Medical Subject Headings: links to NIH * ChEBI: links to EBI * RTECS: no link * ATCvet=yes if the next two parameters define an ATCvet code * ATCCode prefix (first three characters, omit the leading Q for ATCvet codes), internal link * ATCCode suffix (last 4 characters), full ATC links to WHO C.C. * Other ATC codes (use the {{ATC}} and/or {{ATCvet}} templates) * SMILES: no link * InChI: no link '''Section Properties:''' Physical properties * the molecular formula * molecular weight, including unit * Its appearance * Density, including unit. * Melting Point, including unit. * Notes on melting point. * Boiling Point, including unit. * Notes on boiling point. * Partition coefficient * Vapor pressure * Henry's law constant (kH) * Atmospheric OH rate constant * pKa * pKb * Sheet Resistance * Methacrylate Equiv Wt * Bulk Conductivity '''Section Structure:''' Crystal structure information * Crystal Structure * Coordination * Molecular Shape '''Section Thermochemistry:''' Thermochemical properties * Solubility in water * Solubility in other solvents, goes together with next * In which solvent it is soluble * Delta Hc * Delta Hf * Entropy * Heat Capacity '''Section Pharmacology:''' Pharmacology/drug data * Admin Routes * Bioavailability * Metabolism * Half Life * Protein Bound * Excretion * Legal status * Legal status in US * Legal status in UK * Legal status in AU * Legal status in CA * Pregnacy Category * Pregnacy Category in US * Pregnacy Category in AU '''Section Explosive:''' Explosive properties * Shock Sensitivity * Friction Sensitivity * Explosive speed * RE Factor '''Section Hazards:''' Hazards * URL for [[Material Safety Data Sheet * EU Class * EU Index * Main Hazards * NFPA-H: Health * NFPA-F: Fire * NFPA-R: Reactivity * NFPA-O: one of the values W, OX, COR, ALK, ACID, CRYO, RA, or empty * RPhrases: use the {{R-phrase}} template for this * SPhrases: use the ? template for this * RSPhrases: or use the combination of the two above * Flash Point * Autoignition * Explosion Limits * LD50 * PEL '''Section Related:''' Related compounds etc. * Other Anions * Other Cations * Other Function: works with the next field * Function: the function * Other Compounds: chemical 'see also' section -end

Medium form

To use, simply copy and paste the left column into the document, filling in whatever you can, or type {{subst:Chembox subst medium}} and press save:

{{Chembox | Name = | ImageFile = | ImageSize = | ImageAlt = | ImageName = | ImageFile1 = | ImageSize1 = | ImageAlt1 = | ImageName1 = | ImageFile2 = | ImageSize2 = | ImageAlt2 = | ImageName2 = | ImageFile3 = | ImageSize3 = | ImageAlt3 = | ImageName3 = | ImageFileL1 = | ImageSizeL1 = | ImageAltL1 = | ImageNameL1 = | ImageFileR1 = | ImageSizeR1 = | ImageAltR1 = | ImageNameR1 = | ImageFileL2 = | ImageSizeL2 = | ImageAltL2 = | ImageNameL2 = | ImageFileR2 = | ImageSizeR2 = | ImageAltR2 = | ImageNameR2 = | IUPACName = | SystematicName = | OtherNames = | Section1 = {{Chembox Identifiers | 3DMet = | Abbreviations = | ATCvet = | ATCCode_prefix = | ATCCode_suffix = | ATC_Supplemental = | Beilstein = | CASNo = | CASNo_Ref = | CASNos = | CASOther = | ChEBI = | ChemSpiderID = | DrugBank = | EC-number = | EINECS = | EINECSCASNO = | Gmelin = | InChI = | KEGG = | MeSHName = | PubChem = | RTECS = | SMILES = | UNNumber = }} | Section2 = {{Chembox Properties | AtmosphericOHRateConstant = | Appearance = | BoilingPt = | Boiling_notes = | Density = | Formula = | HenryConstant = | LogP = | MolarMass = | MeltingPt = | Melting_notes = | pKa = | pKb = | Solubility = | SolubleOther = | Solvent = | VaporPressure = }} | Section3 = {{Chembox Structure | Coordination = | CrystalStruct = | MolShape = }} | Section4 = {{Chembox Thermochemistry | DeltaHc = | DeltaHf = | Entropy = | HeatCapacity = }} | Section5 = {{Chembox Pharmacology | AdminRoutes = | Bioavail = | Excretion = | HalfLife = | Metabolism = | Legal_status = | Legal_US = | Legal_UK = | Legal_AU = | Legal_CA = | PregCat = | PregCat_AU = | PregCat_US = | ProteinBound = }} | Section6 = {{Chembox Explosive | ExplosiveV = | FrictionSens = | REFactor = | ShockSens = }} | Section7 = {{Chembox Hazards | Autoignition = | EUClass = | EUIndex = | ExploLimits = | ExternalMSDS = | FlashPt = | LD50 = | MainHazards = | NFPA-H = | NFPA-F = | NFPA-R = | NFPA-O = | PEL = | RPhrases = | RSPhrases = | SPhrases = }} | Section8 = {{Chembox Related | Function = | OtherAnions = | OtherCations = | OtherCpds = | OtherFunctn = }} }}

Template name * title (default: article name) * filename.svg (not [[image:filename.svg]] * picture size (example: ImageSize=100px, default=200px) * alt text for picture (example: Fine dry white powder) * Picture caption (example: Oxygen in liquid form) * the IUPAC name * the systematic name * any other name Section Identifiers: Standard numbers etc. * any abbreviations * ATCvet=yes if the next two parameters define an ATCvet code * ATCCode prefix (first three characters, omit the leading Q for ATCvet codes), internal link * ATCCode suffix (last 4 characters), full ATC links to WHO C.C. * Other ATC codes (use the {{ATC}} and/or {{ATCvet}} templates) * CAS Number, links to eMolecules * ChEBI, links to EBI * EINECS, links to ecb; URL is http://ecb.jrc.it/esis/index.php?GENRE=ECNO&ENTREE= * also EINECS, but URL is http://ecb.jrc.it/esis/index.php?GENRE=CASNO&ENTREE= * InChI, no link * KEGG, links to genome.ad.jp * Medical Subject Headings, links to NIH * PubChem, links to pubchem * RTECS, no link * SMILES, no link Section Properties: Physical properties * Atmospheric OH rate constant * Its appearance * Boiling Point, including unit. * Notes on boiling point. * Density, including unit. * the molecular formula * Henry's law constant (kH) * Partition coefficient * molecular weight, including unit * Melting Point, including unit. * Notes on melting point. * pKa * pKb * Solubility in water * Solubility in other solvents, goes together with next * In which solvent it is soluble * Vapor pressure Section Structure: Crystal structure information * Coordination * Crystal Structure * Molecular Shape Section Thermochemistry: Thermochemical properties * Delta Hc * Delta Hf * Entropy * Heat Capacity Section Pharmacology: Pharmacology/drug data * Admin Routes * Bioavailability * Excretion * Half Life * Metabolism * Legal status * Legal status in US * Legal status in UK * Legal status in AU * Legal status in CA * Pregnacy Category * Pregnacy Category in US * Pregnacy Category in AU * Protein Bound Section Explosive: Explosive properties * Explosive speed * Friction Sensitivity * RE Factor * Shock Sensitivity Section Hazards: Hazards * Autoignition * EU Class * EU Index * Explosion Limits * URL for [[Material Safety Data Sheet]] * Flash Point * LD50 * Main Hazards * NFPA-H: Health * NFPA-F: Fire * NFPA-R: Reactivity * NFPA-O: one of the values W, OX, COR, ALK, ACID, CRYO, RA, or empty * PEL * RPhrases: use the {{R}} template for this * RSPhrases: or use the combination of the two above * SPhrases: use the {{S}} template for this Section Related: Related compounds etc. * Function: the function * Other Anions * Other Cations * Other Compounds: chemical 'see also' section * Other Function: works with the next field -end

Advanced fields in main template

There are some extra fields available:

| Reference =

* Can be used for a reference, include <ref> </ref>s with the reference, and add a <references/> to the document.

Advanced and explanations

"Table creep"

The Chembox can handle a lot of parameters, and new ones can easily be added (even more than are shown in the full format). This may result in huge tables in the end. When the table becomes too big, please consider creating a data page 'pagename (data page)', and moving data into that page. Chembox will automagically recognise the existence of the data page, a new box will show, which will have some links into the data page.

Field order

The order of the parameters in this template does not have any effect on the final layout of the template, that order is either programmed in this template (for the top section) or in the following subtemplates:

• {{Chembox Identifiers}}
• {{Chembox Properties}}
• {{Chembox Structure}}
• {{Chembox Thermochemistry}}
• {{Chembox Pharmacology}}
• {{Chembox Explosive}}
• {{Chembox Hazards}}
• {{Chembox Related}}

And the hidden template:

• {{Chembox Supplement}} (only visible when 'pagename (data page)' exists)

The order of the sections can be changed by changing the numbering of the headings 'Section# = {{Chembox section'. This has to be done with some care. Sections that are really without use can be safely removed, renumbering is not necessary.

Extra sections/fields

The setup of the Chembox is modular, one can easily incorporate other boxes in the Chembox, by adding a section. The following sections are available (see these templates for more explanation):

• {{Chembox Identifiers}}
• {{Chembox Properties}}
• {{Chembox Structure}}
• {{Chembox Thermochemistry}}
• {{Chembox Pharmacology}}
• {{Chembox Explosive}}
• {{Chembox Hazards}}
• {{Chembox Related}}

Besides the fields that have been defined in the two forms above, there are many other fields available. In this template those are extra image fields (described below), in the separate sections there are also more fields available. For a full list of available fields see the different section templates.

Parameter display

Except for the more complicated parameters, the display of most parameters is controlled by their own template. This template creates the actual row (if it is displayed is controlled by the section template).

Example:

• The parameter "CASNo" -> {{Chembox CASNo}}
• The parameter "MolarMass" -> {{Chembox MolarMass}}
• The combination of the parameters ATCCode/ATCvet/ATCCode_prefix/ATCCode_suffix/ATCCode_supplemental are controlled by {{Chembox ATCCode}}

Auto images

If there is an image available with the name of the page, that will automatically be used in the template when no other image name is supplied. The order of preference is:

1. If an imagename is supplied in any of the 8 imagefields in the Chembox, then the automatic image will not be used.
2. otherwise, 'pagename.svg' will be used if available
3. otherwise, 'pagename.png' will be used if available
4. otherwise, 'pagename.gif' will be used if available
5. otherwise, 'pagename.jpg' will be used if available
6. otherwise, if there is no image available, the document will be autocategorised in Category:Chemical pages needing a structure drawing (handled by chemistry, image request)

The size of the automatic image is defaulted to 200px, but can be changed with the parameter ImageSize.

Extra images

The Chembox comes standard with one image 'ImageFile' (with a size parameter 'ImageSize'). For certain chemicals more pictures are needed, for which the parameters 'ImageFile1', 'ImageFile2', and 'ImageFile3' are available (each has his own Size-parameter 'ImageSize1', 'ImageSize2', and 'ImageSize3'). The default size for the pictures is set to 200px, normally the ImageSize does not have to be supplied. So a header could look like this:

Chembox
IUPAC name example
Except where noted otherwise, data are given for materials in their standard state (at 25 °C, 100 kPa)
Infobox references

{{Chembox
| ImageFile = Furfural.svg
| ImageSize = 100px
| ImageAlt = Skeleton formula of a ring of four carbons and one oxygen, with a carbon-oxygen attached to a carbon next to an oxygen
| ImageFile1 = Furfural-3D-vdW.png
| ImageSize1 = 150px
| ImageAlt1 = 3D filled-sphere model of the same molecule
| IUPACName = example
}}

This gives two images, each image on his own row (note, ImageFile is the first image, ImageFile1 is the second).

For some chemicals pictures can be really small, and then a side-by-side display is often nicer. Chembox provides two rows which each can contain two images. For these there are the parameters 'ImageFileL1' and 'ImageFileR1' (left and right) for the first row, and 'ImageFileL1' and 'ImageFileR1' for row 2. Each has again his own size-parameter 'ImageSizeL1', 'ImageSizeR1', 'ImageSizeL2', and 'ImageSizeR2'. The header now looks like:

Chembox
IUPAC name example
Except where noted otherwise, data are given for materials in their standard state (at 25 °C, 100 kPa)
Infobox references

{{Chembox
| ImageFileL1 = Furfural.svg
| ImageSizeL1 = 
| ImageAltL1 = Skeleton formula of a ring of four carbons and one oxygen, with a carbon-oxygen attached to a carbon next to an oxygen
| ImageFileR1 = Furfural-3D-vdW.png
| ImageSizeR1 = 
| ImageAltR1 = 3D filled-sphere model of the same molecule
| IUPACName = example
}}

This gives one row with two images. Note that ImageFile is now not supplied.

Combinations are also possible, the order in the template is: 'ImageFile', 'ImageFile1', 'ImageFileL1', 'ImageFileR1', 'ImageFile2', 'ImageFile3', 'ImageFileL2', 'ImageFileR2'. This gives the possibility to play a bit with which image is first (rows with empty parameters are not displayed). Example:

Chembox
IUPAC name example
Except where noted otherwise, data are given for materials in their standard state (at 25 °C, 100 kPa)
Infobox references

{{Chembox
| ImageFileL1 = Furfural.svg
| ImageSizeL1 = 
| ImageAltL1 = Skeleton formula of a ring of four carbons and one oxygen, with a carbon-oxygen attached to a carbon next to an oxygen
| ImageFileR1 = Furfural-3D-vdW.png
| ImageSizeR1 = 
| ImageAltR1 = 3D filled-sphere model of the same molecule
| ImageFile2 = Water droplet blue bg05.jpg
| ImageSize2 = 
| ImageAlt2 = Water droplet erupting from the center of a concentric ring of ripples, evidently in response to a drop landing in the water just before
| IUPACName = example
}}

This gives one row with two images, and one row with one image.

Troubleshooting

• When supplying a parameter with a value, and nothing or the wrong value shows up, check:

• Is the parameter placed in the correct section?
• Is the parameter supplied twice? It will use the value of the second instance
• Are the sections properly defined. Sections start with | section# = {{Chembox sectionname |" and end with "}}".
• Is there inconsistency in the sectionnumbering? Available numbers for sections are 1 - 15, do not use a sectionnumber twice, that will only result in the second section showing up.
• Is the capitalisation of the parameter correct? "Formula" works, "FORMULA" does not.

Adding a parameter

To add a new parameter to the Chembox:

1. Select the section the parameter has to go into, and select a unique parameter name in that section.
2. Edit the section.
3. In the very first if-statement, add "{{{Yourparametername|}}}" to the list, this will make sure that when the parameter is supplied, the section will show. If the new parameter is not in that list, but is the only parameter is not supplied in that section in a document, the section will not show.
4. Add a line for the parameter, follow the example of one of the other lines.
5. Create a new template "Chembox yourparametername", this template formats one complete row in the Chembox (it uses the normal format for a row in a wikitable).

Simple example

Adding 'LD50' to the {{Chembox Hazards}} is summarised in the following three edits:

1. Add the field to the desired sub-box: diff
   1. In the first line the field {{{LD50|}}} is added to the selection line. If one of the parameters in this line is supplied, the box appears (including the header), if all are empty, the box does not show at all. If this is omitted, the box does not appear if this is the only parameter that is supplied!
   2. The second line is the addition of the line itself: {{Chembox entry|par_name={{#if:{{{LD50|}}}|LD50 }} |par_value={{#if:{{{LD50|}}}|{{{LD50}}} }} }}. The placing of the line determines the placing of the field in the box (the order of the fields). The variable 'par_name' determines the sub-box that is called, 'par_value' (and 'par_value1', 'par_value2', etc.) give the parameters to the display template (see 2)
   3. Add the field to the example list for future reference.
2. Create the display template {{Chembox LD50}}. As the chosen fieldname is 'LD50', the name of the display template is 'Chembox LD50'
   1. Contents:
      
      | [[Median lethal dose|LD₅₀]] | {{{value}}} |-<noinclude>[[Category:Chembox templates|{{PAGENAME}}]]</noinclude>
      
      (this is one line of a table, all other parts are determined by the other templates. Should have 2 columns (or otherwise be tweaked to appear as two columns)! First column contains the name as displayed in the left column, the right column contains the formatting for the parameter; parameter is now named '{{{value}}}; further parameters are value1, value2 etc.).
3. Add the field to the main template for reference: diff

The above documentation is transcluded from Template:Chembox/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.

w:Template:Chembox, specifically the version from 19 October 2013, is the source. This is attribution by hyperlink.