Template:Sets taxobox colour/doc
 | This is a documentation subpage for Template:Sets taxobox colour. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on approximately 44,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
Purpose
[edit]{{Sets taxobox colour}} is a utility template used by {{Taxobox}}. It checks whether its argument, which should be a taxon name, has a taxobox colour defined in {{Taxobox colour}} but is not "incertae sedis". If this condition is true, it returns the taxon name, otherwise it returns blank.
Assumption
[edit]The template assumes that colours defined in {{Taxobox colour}} use the format rgb(..,..,..).
Usage
[edit]The template should only be used from within other taxobox templates.
{{Sets taxobox colour|taxon_name}}
It returns the taxon name if the condition is met, otherwise blank.
Examples
[edit]- {{Sets taxobox colour|Animalia}} → Animalia,
- A taxobox colour is explicitly defined for Animalia.
- {{Sets taxobox colour|plantae}} → plantae,
- The taxon name can have an initial capital or not.
- {{Sets taxobox colour|Acacia}} →
- Although Acacia is a plant genus, the taxobox colour is not explicitly defined in {{Taxobox colour}}; in an actual taxobox it is set by finding that Acacia is a member of Plantae.
- {{Sets taxobox colour|incertae sedis}} →
- Although "incertae sedis" has a taxobox colour defined in {{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.)