Editing Template:Cascite/doc

{{Documentation subpage}}
{{suppress categories|{{High-use}}}}
By {{tl|Chembox}} and {{tl|Drugbox}} settings, a [[User:CheMoBot|bot]] checks articles for '''parameter validation'''. The bot then adds and sets templates like {{tlf|cascite}} to the article. Depending on the template settings, articles are categorized for maintenance.

==Usage==
A template is added and set by [[User:CheMoBot]] automatically after certain edits. Depending on the earlier data checks, the template will be marked "correct" or "changed" (i.e., to be checked). 'changed' articles are categorized.

For example, when parameter {{para|CASNo}} is changed in the article, the bot sets {{para|CASNo_Ref|<nowiki>{{cascite|changed|??}}</nowiki>}} initially. See [[WP:CHEMVALID]].

{| class="wikitable sortable collapsible" style="width: 100%;"
|-
|+ Bot-set templates in {{tl|Chembox}} and {{tl|Drugbox}}
|-
! Template !! Verified&nbsp;fields (parameter) !! Category 'changed' !! Default<br/>source !! {{tlf|Chembox}}<br/>conforms !! {{tlf|Drugbox}}<br />conforms
! Monthly<br/>report
|-
| {{tl|cascite}} || {{para|CASNo}}<br/>{{para|CAS_number}} || [[:Category:Articles with changed CASNo identifier|changed CAS number]] || CAS
| {{ya}} || {{ya}}
| {{Template parameter usage|1=Template:cascite|label=usage}}
|-
| {{tl|ebicite}} || {{para|ChEBI}}, {{para|ChEMBL}} || [[:Category:Articles with changed EBI identifier|changed EBI identifier]] || EBI
| {{ya}} || {{ya}}
| {{Template parameter usage|1=Template:ebicite|label=usage}}
|-
| {{tl|chemspidercite}} || {{para|ChemSpiderID}} || [[:Category:Articles with changed ChemSpider identifier|changed ChemSpider identifier]] || ChemSpider
| {{ya}} || {{ya}}
| {{Template parameter usage|1=Template:chemspidercite|label=usage}}
|-
| {{tl|drugbankcite}} || {{para|DrugBank}} || [[:Category:Articles with changed DrugBank identifier|changed DrugBank identifier]] || DrugBank
| {{ya}} || {{ya}}
| {{Template parameter usage|1=Template:drugbankcite|label=usage}}
|-
| {{tl|keggcite}} || {{para|KEGG}} || [[:Category:Articles with changed KEGG identifier|changed KEGG identifier]] || KEGG
| {{ya}} || {{ya}}
| {{Template parameter usage|1=Template:keggcite|label=usage}}
|-
| {{tl|stdinchicite}} || {{para|StdInChI}}, {{para|StdInChIKey}},<br/>{{para|InChIKey}}, {{para|InChI}} || [[:Category:Articles with changed InChI identifier|changed InChI identifier]] || ChemSpider
| {{ya}} || {{ya}}
| {{Template parameter usage|1=Template:stdinchicite|label=usage}}
|-
| {{tl|fdacite}} || {{para|UNII}} || [[:Category:Articles with changed FDA identifier|changed FDA identifier]] || FDA
| {{ya}} || {{ya}}
| {{Template parameter usage|1=Template:fdacite|label=usage}}
|-
| {{tl|chemboximage}} || {{para|ImageFile[L/R]}} || [[:Category:Articles with changed Chembox image|changed Chembox image file]] || {{CNone|''(none)''}}
| {{na}} || {{n/a}}
| {{Template parameter usage|1=Template:chemboximage|label=usage}}

|}<!--

-->

==Added by the bot (<code>_Ref=cite</code> templates)==
The bot-template is added as input for a purpose-added parameter:
:{{para|CASNo|1234-56-7}} (editors input)
:{{para|CASNo_Ref|<nowiki>{{cascite|...|...}}</nowiki>}} (bot parameter added + template set)
Initially the parameters are set <nowiki>{{cascite|changed|??}}</nowiki>

The primary parameter can have an index (see its documentation):
:{{para|CASNo'''3'''|1234-56-7}}
:{{para|CASNo'''3'''_Ref|<nowiki>{{cascite|...|...}}</nowiki>}}
Indexed parameters like {{para|CASNo1}} and {{para|CASNo2}} are verified too, and are treated independently. So an article can have: {{para|'''CASNo'''|2=<nowiki>{{cascite|correct|CAS}}</nowiki>}} and {{para|'''CASNo3'''|2=<nowiki>{{cascite|changed}}</nowiki>}}.

==Data 'correct' or 'changed' (parameter #1)==
The first parameter is either <code>correct</code>&nbsp;<sup>{{tick|7}}</sup> or <code>changed</code>&nbsp;<sup>{{xmark|7}}</sup> always: {{tlx|cascite|correct|CAS}}. Cross-marked articles are categorized as 'changed'. With any other text like <code>monkey</code> <sup>{{xmark|7}}</sup>, again the cross is shown and the article is categorized, now sorted under "?".

==Correct by source (parameter #2)==
Initially, the bot sets this to {{para|2=??}} (='source unknown').
Parameter #2 has the source that confirms the statement. By confirmation, the parameter can mention the confirming source. When that source is not the standard (as listed above), the input source is mentioned in a superscript linked:
:{{para|CASNo_Ref|<nowiki>{{cascite|correct|CDC85}}</nowiki>}} &rarr; 1234-56-7{{cascite|correct|CDC85}}

This source name is case-insensitive: CAS=cas.

==Known issues (February 2015)==
* {{tlf|chemboximage}} is applied by the bot, but not read by the template (article won't show up in the category).

==TemplateData==
{{TemplateData header}}
{{collapse top}}
<templatedata>
{
	"params": {
		"1": {
			"description": "Either 'correct' or 'changed'",
			"type": "string",
			"required": true
		},
		"2": {
			"description": "Source used to verify reference or ?? for no source",
			"type": "string",
			"default": "??",
			"required": true
		}
	},
	"description": "Gives details of source verification, automatically generated by CheMoBot, should not be edited manually.",
	"format": "inline"
}
</templatedata>
{{collapse bottom}}

==See also==
* {{cl|Chemboxes which contain changes to verified fields}}
* {{tl|Chembox}}
* [[WP:WikiProject Chemicals/Chembox validation]]
* [[:User:CheMoBot]]
* {{tl|Infobox drug}}

<includeonly>{{template other|{{Sandbox other||
[[Category:Templates used by CheMoBot]]
[[Category:Specific-source templates]]
[[Category:Wikipedia chemical data validation|cascite]]
}}}}</includeonly>