Template:Colour key/doc

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Colour key in articles based on its TemplateData.

TemplateData for Colour key

Displaying a colour key

Template parameters

Parameter		Description	Type	Status
Colour	1	Colour code of the area Default black	String	optional
Description	2	Explanation of the meaning of the colour	String	optional
Colour name	3	Name of the colour if not standard	String	optional

Usage

{{Colour key|Colour code|Description}}
{{Colour key|Colour code|Description|Colour name}}

The colour code is forwarded to the CSS property border-left-color. Standard (named) web colours, such as red, should preferably be used to aid clarity. It is also permitted, however, to use any other valid CSS code, e.g. #FF0000, #F00 or rgb(100%, 0%, 0%).

The optional parameter, "colour name" is shown as a tooltip as well as in printed and pdf views and is intended inter alia for colour blind users.

Examples

Entry	Result
{{Colour key|black|Africa}} {{Colour key|green|Europe}} {{Colour key|blue|Oceania}} {{Colour key|#ff0|Asia}} {{Colour key|#ff2800|America}}	Africa Europe Oceania Asia America
{{Colour key}}	
{{Colour key|red}}	
{{Colour key|red|Example}}	Example
{{Colour key|red|Example|Red areas}}	Example

See also

• Help:Using colours
• Commons:Template:legend