View source for Template:GHS phrases/doc

{{Documentation subpage}}
{{Lua|Module:GHS phrases|Module:GHS phrases/data}}
The templates '''{{tlt|GHS phrases}}''' ([[:Template:GHS phrases/testcases|/tests]]), '''{{tl|H-phrases}}''' and '''{{tl|P-phrases}}''' all format and present [[Globally Harmonized System of Classification and Labelling of Chemicals|GHS hazard and precaution statements]] as defined by the UN.{{GHS2021|ref|annex=3}}

The template requires one or more phrase codes as input:
* <code><nowiki>{{GHS phrases|H220|H230}}</nowiki></code> &rarr; {{GHS phrases|H220|H230}}
* <code><nowiki>{{H-phrases|H220|H230}}</nowiki></code> &rarr; {{H-phrases|H220|H230}}
* <code><nowiki>{{P-phrases| P220 | P230}}</nowiki></code> &rarr; {{P-phrases| P220 | P230}}
* <code><nowiki>{{H-phrases|H302  + 312}}</nowiki></code> &rarr; {{H-phrases|H302  + 312}} <small>-- (Predefined combination, recognised)</small>

Pages with errors or warnings show a {{button|Preview}} message. Articles are then listed in {{clc|GHS errors|pages}}, {{clc|GHS warnings|pages}}.

==Usage==
:While one can use {{tl|GHS phrases}} stand-alone in text, more common use is in {{tl|Chembox}}, section {{code|Chembox Hazards}}:
{{Chembox|container_only=yes
| Name=[[DDT]] GHS phrases
| Section7 = {{Chembox Hazards
| HPhrases = {{H-phrases|H301|H351|H372|H410}}
| PPhrases = {{P-phrases|P201|P202|P260|P264|P270|P273|P281|P301+P310|P308+P313|P314|P321|P330|P391|P405|P501}}
}}}}
<pre>
{{Chembox
| Section7 = {{Chembox Hazards
| HPhrases = {{H-phrases|H301|H351|H372|H410}}
| PPhrases = {{P-phrases|P201|P202|P260|P264|P270|P273|P281|P301+P310|P308+P313|P314|P321|P330|P391|P405|P501}}
}}
}}
</pre>

===Synonyms: {{tlf|HPhrases}}===
For ease of working in {{tlf|Chembox}}, the templates have synonyms (redirects) ''same as the Chembox parameter name'':

 <code><nowiki>|Section3 = {{Chembox Hazards</nowiki></code>
 {{para|HPhrases|<nowiki>{{HPhrases|H300}}</nowiki>}}
 {{para|PPhrases|<nowiki>{{PPhrases|P300}}</nowiki>}}
 <code><nowiki> }}</nowiki></code>


===Parameters===
* The number of phrase code one can enter is practically unlimited. The codes are ordered alphanumeric.
:'''Best practice''': ''add prefix {{mono|H}} or {{mono|P}} to the number'': {{xt|{{!}}H220}}, not {{!xt|{{!}}220}}.
:One template call can only show one prefix set. That is, {{mono|H}}- and  {{mono|P}}-phrases cannot be mixed.
* {{para|setid|}} ({{mono|H}} or {{mono|P}}) can be set to prevent ambiguity in generic {{tlf|GHS phrases}}.

For backward compatability, the code prefix "H" or "P" is not required. So <code><nowiki>{{H-phrases|220}}</nowiki></code> equals <code><nowiki>{{H-phrases|H220}}</nowiki></code> &rarr; {{H-phrases|H220}}. However. Since {{tl|GHS phrases}} covers both {{mono|H}} and {{mono|P}}, adding the prefix is better.

==Code checks added==
===Omit Rules===
* {{tl|GHS phrases/list omit rules}}
:{{para|omit|true}} (default)
{{GHS phrases/list omit rules|expand=false}}

* <code><nowiki>{{GHS phrases|H314|H318}}</nowiki></code> &rarr; {{GHS phrases|H314|H318}}

===Remove Doubles===
Repeated phrase codes are removed (hidden):
* <code><nowiki>{{GHS phrases|H400|H401|H401|H401}}</nowiki></code> &rarr; {{GHS phrases|H400|H401|H401|H401}}

==Other functions==
* {{tl|GHS phrases/inline}} -- inline, with full phrase text
* {{tl|GHS phrases/list_all}} -- table, by {{para|setid|H, P}}
* {{tl|GHS phrases/number of phrases}} -- by {{para|setid|H, P}}
* {{tl|GHS phrases/list omit rules}} -- table, documentation
* {{para|list|}} -- See {{slink||List options}}
===List options===
* Using {{para|list}}, {{tl|GHS phrases}} can be presented in various ''list formats'':
:{{para|1=list|2=abbr, inline, bulleted, unbulleted, horizontal, ordered, horizontal_ordered}}
; {{para|listtype|abbr}} {{nobold|(default)}}
:{{GHS phrases|P201 |P302+P334 |P502 |listtype=abbr}}

; {{para|listtype|inline}}
:{{GHS phrases|P201 |P302+P334 |P502 |listtype=inline}}

; {{para|listtype|bulleted}}
:{{GHS phrases|P201 |P302+P334 |P502 |listtype=bulleted}}

; {{para|listtype|unbulleted}}
:{{GHS phrases|P201 |P302+P334 |P502 |listtype=unbulleted}}

; {{para|listtype|horizontal}}
:{{GHS phrases|P201 |P302+P334 |P502 |listtype=horizontal}}

; {{para|listtype|ordered}}
:{{GHS phrases|P201 |P302+P334 |P502 |listtype=ordered}}

; {{para|listtype|horizontal_ordered}}
:{{GHS phrases|P201 |P302+P334 |P502 |listtype=horizontal_ordered}}

* Except for {{mono|abbr, inline}}, these list formats are defined in [[:Module:List]]

==Errors and warnings==
Phrase codes that are unknown get an inline marker like <sup><nowiki>[?]</nowiki></sup>, give a warning in {{button|preview}} and are categorised in {{cl|GHS errors}} when in article space.

For example (One can see the warning when previewing this page or section):
* <code><nowiki>{{H-phrases|H220|H999}}</nowiki></code> &rarr; {{H-phrases|H220|H999}}

==Templates==
===H-phrases===
:<code><nowiki>{{H-phrases|H200|H241}}</nowiki></code> &rarr; {{H-phrases|200|241}}
:<code><nowiki>{{H-phrases|H302+H312}}</nowiki></code> &rarr; {{H-phrases|H302+H312}}

{{GHS phrases/list_all|setid=H|state=collapsed}}

===P-phrases===
:<code><nowiki>{{P-phrases|P101|P263}}</nowiki></code> &rarr; {{P-phrases|P101|P263}}
:<code><nowiki>{{P-phrases|P306+P360}}</nowiki></code> &rarr; {{P-phrases|P306+P360}}
{{GHS phrases/list_all|setid=P|state=collapsed}}

===GHS phrases===
* <code><nowiki>{{GHS phrases|H220}}</nowiki></code> &rarr; {{GHS phrases|H220}}
* <code><nowiki>{{GHS phrases|P220}}</nowiki></code> &rarr; {{GHS phrases|P220}}

===GHS inline===
* {{tl|GHS inline}} lists the phrases ''inline'', to be used in regular sentences.
:<code><nowiki>{{GHS inline|H220|H401}}</nowiki></code> &rarr; {{GHS inline|H220|H401}}
:<code><nowiki>{{GHS inline|P220|P501}}</nowiki></code> &rarr; {{GHS inline|P220|P501}}

:''See also'' {{slink||List options}}.


===Errors and warnings===
;Unknown phrase code
* <code><nowiki>{{GHS phrases|H220|H999}}</nowiki></code> &rarr; {{H-phrases|H220|H999}}

;Set id missing
::Set id is entered as {{para|setid|&lt;H, P>}}, <small>(default in {{tlf|H-phrases}}, {{tlf|P-phrases}})</small>, ''or'' when {{para|setid}} is absent, is sought in the code list entered:  {{mono|H}} from <code><nowiki>{{GHS phrases|310|H341}}</nowiki></code> &rarr; {{GHS phrases|310|H341}}
* <code><nowiki>{{GHS phrases|321|310|H341}}</nowiki></code> &rarr; {{GHS phrases|321|310|H341}}

;Could not find a set id
* <code><nowiki>{{GHS phrases|302+312}}</nowiki></code> &rarr; {{GHS phrases|302  + 312}} <small>-- (missing prefix H/P may leave undecided results (ambiguity))</small>


==Overview==
Some settings are available to present an overview of the phrases. They are article-ready.

===Number of phrases===
* <code><nowiki>{{GHS phrases/number of phrases|setid=P}}</nowiki></code> &rarr; {{GHS phrases/number of phrases|setid=P}}
* <code><nowiki>{{GHS phrases/number of phrases|setid=H}}</nowiki></code> &rarr; {{GHS phrases/number of phrases|setid=H}}

===Complete list (table)===
*{{tl|GHS phrases/list_all}} returns a wikitable that lists all available phrase codes per prefix.
:{{para|setid|2={{mono|H}}, {{mono|P}}}}. '''Required.'''
:{{para|title}} Optional. Default is: see {{slink||Number of phrases}}.
:{{para|state|collapsed}} Optional. Default is: uncollapsed.

==Tracking==
:Help/documentation page: [[:Template:GHS phrases]]
:{{clc|GHS errors|pages}}
:{{clc|GHS warnings|pages}}

==Template data==
{{templatedata header}}
{{collapse top|title=Template Data|bg=#ccc}}
<includeonly>{{sandbox other||
[[Category:GHS templates|Phrases]]
}}</includeonly>
<templatedata>
{
	"params": {
		"1": {
			"description": "Phrase code",
			"example": "H220, P431",
			"type": "string",
			"suggested": true
		},
		"2": {},
		"3": {},
		"4": {},
		"5": {},
		"6": {},
		"7": {},
		"8": {},
		"9": {},
		"10": {},
		"setid": {
			"label": "set ID",
			"description": "Defined plain numbers to be \"H\" or \"P\"; better add prefix to number: \"H220\"",
			"type": "string",
			"suggestedvalues": [
				"H, P"
			]
		},
		"omit": {
			"label": "Omit Rules",
			"description": "Apply Omit Rules like \"omit (remove) P203 when P103 is present\"",
			"example": "yes",
			"type": "boolean",
			"default": "true"
		},
		"listtype": {
			"label": "List type",
			"description": "List format of the result",
			"example": "listtype=bulleted",
			"type": "string",
			"suggestedvalues": [
				"abbr, inline, bulleted, unbulleted, horizontal, ordered, horizontal ordered"
			],
			"default": "abbr"
		}
	},
	"description": "Formats and presents predefined GHS hazard statements.",
	"paramOrder": [
		"1",
		"2",
		"3",
		"4",
		"5",
		"6",
		"7",
		"8",
		"9",
		"10",
		"setid",
		"omit",
		"listtype"
	]
}
</templatedata>
{{collapse bottom}}

==See also==
* Main [[Globally Harmonized System of Classification and Labelling of Chemicals]]

==Development==
===Errors and warnings (newdoc)===
;Errors
:All errors show a preview-message in {{button|Preview}}.
:Categorisation is in {{clc|GHS errors}}, articles only (mainspace).
* {{para|setid|H, P, &lt;blank>}} missing
* {{para|setid|XYZ}} not recognised
::When entered: in {{tlf|GHS phrases}}, a {{code|setid}} check is enforced. Is present by default in {{tlf|H-phrases}} etc. 
::When setid is missing, any first setid in the codes-list is used. So {{code|1={{!}}310 {{!}}3220 {{!}}H333}} &rarr; {{code|H}}.
::This also occurs when setid=H and a P-phrase is entered.
::In certain listings, like {{tlf|GHS phrases/list all}}, a blank setid returns the full list (all H- and P-phrases). No error.
::Catsort: H, P, 
* '''Phase codes''' that are not in the list (like {{code|1={{!}}H999}}) generate an error &rarr; error

* '''Parameter unknown''' {{para|foo}}: catsort under U

;Warnings
:All warnings show a preview-message in {{button|Preview}}.
:Categorisation in {{clc|GHS warnings}}, articles only (mainspace).

* When {{slink||Omit Rules}} is applied, a warning is made mentioning the two involved phrase codes. Catsort=O
* When {{slink||Redundancy}} is present,  a warning is made mentioning the involved phrase code. Catsort=D

===dev links===
;Subtempaltes:
* {{tl|GHS phrases/list all}}
* {{tl|GHS phrases/inline}}
* {{tl|GHS phrases/number of phrases}}
* {{tl|GHS phrases/list omit rules}} -- documentation
* {{tl|GHS2021}} -- {{tlf|Cite web}}
:Source: {{GHS2021|noref|annex=3}}

;Chembox
;Definition of phrases
* [[:Module:GHS phrases/data]]
* [[:de:Vorlage:H-Sätze]], [[:de:Vorlage:P-Sätze]]

===Developments ===
* {{tlt|Chembox}}, {{tl|Chembox Hazards}}, [[:Template:Chembox/doc/full parameter list|/full parameter list]]
:{{clc|Category:Chembox templates|pages}}
:{{clc|Chembox tracking categories}}
* {{tl|EUH-phrases}};

<pre>
| GHSPictograms = 
| GHSSignalWord = 
| HPhrases      = {{HPhrases|}}
| PPhrases      = {{PPhrases|}}
| GHS_ref       = 
</pre>
{{GHS pictograms overview|state=mw-collapsed}}
{{reflist-template}}
<includeonly>{{sandbox other||
[[Category:GHS templates|phrases]]
}}</includeonly>