View source for Template:Sets taxobox colour/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{high use|225455}}
==Purpose==
{{tl|Sets taxobox colour}} is a utility template used by {{tl|Taxobox}}. It checks whether its argument, which should be a taxon name, has a taxobox colour defined in {{tl|Taxobox colour}} but is not "incertae sedis". If this condition is true, it returns the taxon name, otherwise it returns blank.

==Assumption==
The template assumes that colours defined in {{tl|Taxobox colour}} use the format <code>rgb(..,..,..)</code>.

==Usage==
The template should only be used from within other taxobox templates.

<code><nowiki>{{Sets taxobox colour|</nowiki>''taxon_name''<nowiki>}}</nowiki></code>

It returns the taxon name if the condition is met, otherwise blank.

==Examples==
*<nowiki>{{Sets taxobox colour|Animalia}}</nowiki> → {{Sets taxobox colour|Animalia}}
:A taxobox colour is explicitly defined for Animalia.
*<nowiki>{{Sets taxobox colour|plantae}}</nowiki> → {{Sets taxobox colour|plantae}}
:The taxon name can have an initial capital or not.
*<nowiki>{{Sets taxobox colour|Acacia}}</nowiki> → {{Sets taxobox colour|Acacia}}
:Although ''Acacia'' is a plant genus, the taxobox colour is not explicitly defined in {{tl|Taxobox colour}}; in an actual taxobox it is set by finding that ''Acacia'' is a member of Plantae.
*<nowiki>{{Sets taxobox colour|incertae sedis}}</nowiki> → {{Sets taxobox colour|incertae sedis}}
:Although "incertae sedis" has a taxobox colour defined in {{tl|Taxobox colour}}, it is ignored. (This is so that templates that use this one can continue to look higher up the taxonomic hierarchy to see if there is a more appropriate colour; an ''incertae sedis'' family, for example, may be known to be an animal, when the Animalia colour should be used.)
<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Taxobox templates]]
}}</includeonly>