View source for Template:NFPA 704 diamond/doc

{{Documentation subpage}}
{{Uses TemplateStyles|Template:NFPA 704 diamond/styles.css}}
This template produces a '''[[NFPA 704]] safety square''' with optionally four hazard codes. It is designed to be used in a table.

Primary use is through {{tl|Chembox}}, the {{tl|NFPA 704}} box and {{tl|OrganicBox complete}} (chemical data pages).

When used stand-alone (outside of a table), consider the {{tl|NFPA 704}} box.

==Parameters==
{|
|-
|<pre>
{{NFPA 704 diamond
 | H          =
 | F          =
 | I          =
 | S          =
 | ref        =
 | showimage  =
 | background =
}}
</pre>
|
<pre>
&nbsp;
Health code, 0-4 or - (hyphen for blank)
Flammability code
Instability (reactivity) code ("R=" is also allowed)
Special code W, OX, W+OX, ..., or - (hyphen for blank)
References. Add the &lt;ref&gt; ... &lt;/ref&gt; tags.
Set =no to show text instead ('RA' only. Default: =yes, show image)
background color (e.g., =yellow or =#ff7623)
}}
</pre>
|}

==Input options==
Main rule: if the quarter ''must'' be blank, input is the ''hyphen'', {{key press|-}}. Do not depend on default behavior in this situation.
===Basic 0&ndash;4 and - (hyphen)===
{| class="infobox bordered" cellspacing=0 cellpadding=0 style="padding:0; background:lemonchiffon"
|- style="text-align:center; line-height:250%;"
| colspan=6 | for {{para|H|}}, {{para|F|}}, {{para|I|}}
|- style="text-align:center; line-height:200%;"
| {{code|1==0}} || {{code|1==1}} || {{code|1==2}} || {{code|1==3}} || {{code|1==4}} || {{code|1==-}} (hyphen)
|-
|{{NFPA 704 diamond|H=0|F=0|I=0|S=-}}
|{{NFPA 704 diamond|H=1|F=1|I=1|S=-}}
|{{NFPA 704 diamond|H=2|F=2|I=2|S=-}}
|{{NFPA 704 diamond|H=3|F=3|I=3|S=-}}
|{{NFPA 704 diamond|H=4|F=4|I=4|S=-}}
|{{NFPA 704 diamond|H=-|F=-|I=-|S=-}}
|}
Parameters {{para|H|}}, {{para|F|}},&nbsp;{{para|I|}} accept codes <code>0, 1, 2, 3,&nbsp;4,&nbsp;-</code>. Code <code>-</code>&nbsp;(hyphen) produces a blank ("no hazard code").{{clear}}

A blank can be set (enforced) by entering {{code|1==-}}, a hyphen. This is the preferred way to ''reflect what the source states'' (don't depend on the ''default'' blank in this situation).

===Default code (blank)===
{| class="infobox bordered" style="background:lemonchiffon"
|-
| style="text-align:center;" | {{code|1=<nowiki>=</nowiki>}} &lt;blank>
|-
| {{NFPA 704 diamond|H=|F=|I=|S=}}
|}
All four codes default to blank, that is: no NFPA code is present or shown. There is no specific text (just a link to the NFPA color section). Note that a blank is ''not'' the same as code "0". Code "0" is an explicit statement, while a blank is the absence of any statement.

A blank can also be enforced by entering {{code|1==-}} (hyphen). This is the preferred way to ''reflect what the source states'' (do not depend on default).

From the input, spaces and even newlines (all [[Whitespace character|whitespace]]) are treated as blank. Note that <code>=&amp;nbsp;</code> code produces an error, but entering the nbsp character (>{{code|1==}} <) is accepted as a space (blank).
{{clear}}

===Special hazard options===
{| class="infobox bordered" style="background:lemonchiffon"
|-
| {{para|S|W}}
| {{para|S|OX}}
| {{para|S|W+OX}}
| {{para|S|SA}}
| {{para|S|-}} (hyphen)
|-
|{{NFPA 704 diamond|H=-|F=-|I=-|S=w}}
|{{NFPA 704 diamond|H=-|F=-|I=-|S=ox}}
|{{NFPA 704 diamond|H=-|F=-|I=-|S=w+ox}}
|{{NFPA 704 diamond|H=-|F=-|I=-|S=sa}}
|{{NFPA 704 diamond|H=-|F=-|I=-|S=-}}
|-
| colspan=5 |
|-
| {{para|S|ACID}}
| {{para|S|ALK}}
| {{para|S|COR}}
| {{para|S|CRYO}}
| {{para|S|POI}}
|-
|{{NFPA 704 diamond|H=-|F=-|I=-|S=acid}}
|{{NFPA 704 diamond|H=-|F=-|I=-|S=alk}}
|{{NFPA 704 diamond|H=-|F=-|I=-|S=cor}}
|{{NFPA 704 diamond|H=-|F=-|I=-|S=cryo}}
|{{NFPA 704 diamond|H=-|F=-|I=-|S=poi}}
|-
| colspan=5 |
|-
| {{para|S|RA}}<br>{{para|showimage|&lt;default>}}
| {{para|S|RA}}<br>{{para|showimage|yes}}
| {{para|S|RA}}<br>{{para|showimage|no}}
|-
| {{NFPA 704 diamond|H=-|F=-|I=-|S=ra}}
| {{NFPA 704 diamond|H=-|F=-|I=-|S=ra|showimage=yes}}
| {{NFPA 704 diamond|H=-|F=-|I=-|S=ra|showimage=no}}
|-
| colspan=5 |
|-
| {{para|S|BIO}}<br>{{para|showimage|&lt;default>}}
| {{para|S|BIO}}<br>{{para|showimage|yes}}
| {{para|S|BIO}}<br>{{para|showimage|no}}
|-
| {{NFPA 704 diamond|H=-|F=-|I=-|S=bio}}
| {{NFPA 704 diamond|H=-|F=-|I=-|S=bio|showimage=yes}}
| {{NFPA 704 diamond|H=-|F=-|I=-|S=bio|showimage=no}}
|}
For <code><s>W</s></code> enter {{para|S|W}}.

For <code><s>W</s> OX</code> enter {{para|S|W+OX}}, {{para|S|W OX}} or {{para|S|WOX}}.

The "Special" quarter is sometimes called "Other".
{{clear}}

===Unknown codes (error)===
The diamond template checks for unknown codes.

{| class="infobox bordered" style="vertical-align:top; background:lemonchiffon"
|-
| {{code|1==abc}} || {{code|1==&nbsp;}} || {{code|1==abc}}<br>{{para|cat|no}}
|- style="vertical-align:top;"
| {{NFPA 704 diamond|H=abc|F=klm|I=pqr|S=xyz}}
| {{NFPA 704 diamond|H=&nbsp;|F=&nbsp;|I=&nbsp;|S=&nbsp;}}
| {{NFPA 704 diamond|H=abc|F=klm|I=pqr|S=xyz|cat=no}}
|}
Articles with unknown codes are listed for maintenance (correction) in {{clc|Articles with unknown NFPA 704 code}}. Other pages (like this documentation) are not categorized, but have a message instead. This categorizing can be switched off by setting {{para|cat|no}}

Note that <code>=&amp;nbsp;</code> ''code'' produces an error, but entering the nbsp ''character'' (=&nbsp;) is accepted as a space (blank).
{{clear}}

==Adding references==
References can be added using {{para|ref|}}.

:<code><nowiki>|ref=<ref>{{cite web|url=http://chemlabs.uoregon.edu/Safety/NFPA_White.html|title=More on white codes}}</ref></nowiki></code>
{| class="infobox bordered" cellpadding=0 style="background:lemonchiffon"
|-
|{{NFPA 704 diamond|H=2|F=2|I=2|S=|ref=<ref>{{cite web|url=http://chemlabs.uoregon.edu/Safety/NFPA_White.html|title=some title}}</ref>}}
|}
The &lt;ref> ... &lt;/ref> tags should be added. Multiple references can be entered. Depending on cell width, the links show above or next to the diamond. While technically possible to enter plain text, this is ''not'' supported (and this could be disallowed in the future).
{| class="infobox bordered" cellspacing=0 cellpadding=0 style="width:70%;padding:0; background:lemonchiffon"
|-
| {{NFPA 704 diamond|H=-|F=-|I=-|S=-|showimage=no|ref=<ref>[http://chemlabs.uoregon.edu/Safety/NFPA_White.html]</ref>}}
| {{NFPA 704 diamond|H=-|F=-|I=-|S=RA|showimage=no|ref=<ref>[http://chemlabs.uoregon.edu/Safety/NFPA_White.html]</ref>}}
| {{NFPA 704 diamond|H=-|F=-|I=-|S=OX|showimage=yes|ref=<ref>[http://chemlabs.uoregon.edu/Safety/NFPA_White.html]</ref>}}
| {{NFPA 704 diamond|H=-|F=-|I=-|S=OX|showimage=no|ref=<ref>{{cite web|url=http://chemlabs.uoregon.edu/Safety/NFPA_White.html|title=some title}}</ref><ref>[http://chemlabs.uoregon.edu/Safety/NFPA_White.html]</ref><ref>[http://chemlabs.uoregon.edu/Safety/NFPA_Blue.html]</ref>}}
|}
{| class="infobox bordered" cellpadding=0 style="background:lemonchiffon"
|-
|{{NFPA 704 diamond|H=2|F=2|I=2|S=|ref=<ref>{{cite web|url=http://chemlabs.uoregon.edu/Safety/NFPA_White.html|title=some title}}</ref>}}
|{{NFPA 704 diamond|H=0|F=0|I=0|S=|ref=<ref>[http://chemlabs.uoregon.edu/Safety/NFPA_White.html]</ref>}}
|{{NFPA 704 diamond|H=1|F=1|I=1|S=|ref=[http://chemlabs.uoregon.edu/Safety/NFPA_White.html]}}
|{{NFPA 704 diamond|H=2|F=2|I=2|S=|ref={{cite web|url=http://chemlabs.uoregon.edu/Safety/NFPA_White.html|title=some title}}}}
|{{NFPA 704 diamond|H=4|F=4|I=4|S=|ref=<ref>{{cite web|url=http://chemlabs.uoregon.edu/Safety/NFPA_White.html|title=some title}}</ref><ref>[http://chemlabs.uoregon.edu/Safety/NFPA_White.html]</ref><ref>[http://chemlabs.uoregon.edu/Safety/NFPA_Blue.html]</ref>}}
|}
{{clear}}

==List of codes {{anchor|Code description}}==
{{NFPA 704 diamond/codes-overview}}

==Color style==
:Option {{para|background|2=green}}. Default is {{code|1=transparent}}.
{| class=wikitable cellpadding=0 style="background:lemonchiffon"
|-
|{{NFPA 704 diamond|H=2|F=2|I=2|S=-|background=green|ref=<ref>{{cite web|url=http://chemlabs.uoregon.edu/Safety/NFPA_White.html|title=some title}}</ref>}}
|}

'''Colors used'''
{| class="wikitable nounderlines" style="text-align:center; font-size:big; width:20em;"
|-
! Blue !! Red !! Yellow !! White
|-
| style="background:#6691ff;" | '''1'''
| style="background:#ff6666;" | '''4'''
| style="background:#fcff66;" | '''3'''
| style="background:#ffffff;" | '''SA'''
|-
| <code>#6691ff</code>
| <code>#ff6666</code>
| <code>#fcff66</code>
| <code>#ffffff</code>
|}

Better not to use RGB colors named <code>blue, red, yellow</code>, because these produce a bad contrast with the text.


==Template data==
{{template data header}}
<templatedata>
{
	"params": {
		"ref": {},
		"background": {},
		"H": {
			"suggestedvalues": [
				"0, 1, 2, 3, 4, -"
			],
			"label": "Health (blue)",
			"type": "string"
		},
		"F": {
			"suggestedvalues": [
				"0, 1, 2, 3, 4, -"
			],
			"label": "Flammability (red)",
			"type": "string"
		},
		"I": {
			"aliases": [
				"R"
			],
			"type": "string",
			"suggestedvalues": [
				"0, 1, 2, 3, 4, -"
			],
			"label": "Instability, Reactivity (yellow)"
		},
		"S": {
			"label": "Special code (white)",
			"type": "string",
			"suggestedvalues": [
				" OX, W, WOX, W+OX, ACID, ALK, BIO, COR, CRYO, RA"
			]
		},
		"showimage": {
			"description": "shows S image when available",
			"type": "boolean"
		},
		"cat": {}
	},
	"paramOrder": [
		"H",
		"F",
		"I",
		"S",
		"background",
		"ref",
		"showimage",
		"cat"
	]
}
</templatedata>


==Known issues==
* Is there an ENGVAR-like switch needed, eg for the order of &deg;C - &deg;F temperatures? (Currently, &deg;C is first)
* For documentation, could use a diamond with the four letters in the quadrants.
* The non-standard S (on white) codes should be complete, and maybe listed for attention.

==Tracking category==
* {{clc|Articles with unknown NFPA 704 code}}

==See also==
* [[:File:NFPA 704.svg]] -- The background diamond image
* {{tl|NFPA 704}} -- in a stand alone box
* {{tl|NFPA 704 diamond/text}}

{{template reference list}}
:''The references are from the demos in this documentation.''
<includeonly>{{sandbox other||
{{#ifeq:{{PAGENAME}}|NFPA 704 diamond|
[[Category:Templates used in Chembox]]
[[Category:Templates that add a tracking category]]
}}}}</includeonly>