Template:Colour key
File:Test Template Info-Icon - Version (2).svg Template documentation[view] [edit] [history] [purge]
.svg){kind=link}
TemplateData[change]
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
<templatedata> { "description": "Displaying a colour key",
"params": { "1":
{ "label": "Colour",
"description": "Colour code of the area",
"type": "string",
"required": false,
"default": "black"
},
"2":
{ "label": "Description",
"description": "Explanation of the meaning of the colour",
"type": "string",
"required": false
},
"3":
{ "label": "Colour name",
"description": "Name of the colour if not standard",
"type": "string",
"required": false
}
}
} </templatedata>
Usage[change]
{{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[change]
| Entry | Result |
|---|---|
{{Colour key|black|Africa}}
|
|
{{Colour key}} |
|
{{Colour key|red}} |
|
{{Colour key|red|Example}} |
|
{{Colour key|red|Example|Red areas}} |