Difference between revisions of "Template:Colour key/doc"
Jump to navigation
Jump to search
imported>Bermicourt (m) |
imported>Bermicourt (m) |
||
Line 21: | Line 21: | ||
"3": | "3": | ||
{ "label": "Colour name", | { "label": "Colour name", | ||
− | "description": " | + | "description": "Name of the colour if not standard", |
"type": "string", | "type": "string", | ||
"required": false | "required": false | ||
Line 34: | Line 34: | ||
{{Colour key|Colour code|Description|Colour name}}</pre> | {{Colour key|Colour code|Description|Colour name}}</pre> | ||
− | The ''colour code'' is forwarded to the [[Cascading Style Sheets|CSS]] property <code>border-left-color</code>. | + | The ''colour code'' is forwarded to the [[Cascading Style Sheets|CSS]] property <code>border-left-color</code>. Standard (named) [[web colour]]s, such as <code>red</code>, should preferably be used to aid clarity. It is also permitted, however, to use any other valid CSS code, e.g. <code>#FF0000</code>, <code>#F00</code> or <code>rgb(100%, 0%, 0%)</code>. |
The optional parameter, "colour name" is shown as a [[tooltip]] as well as in printed and pdf views and is intended ''inter alia'' for [[Wikipedia:Manual of Style/Accessibility#Color|colour blind users]]. | The optional parameter, "colour name" is shown as a [[tooltip]] as well as in printed and pdf views and is intended ''inter alia'' for [[Wikipedia:Manual of Style/Accessibility#Color|colour blind users]]. |
Revision as of 16:22, 7 October 2013
![]() | This is a documentation subpage for Template:Colour key. It contains usage information, categories and other content that is not part of the original template page. |
Displaying a colour key
Parameter | Description | Type | Status | |
---|---|---|---|---|
Colour | 1 | Colour code of the area
| 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}}
|
Africa
Europe
Oceania
Asia
America
|
{{Colour key}} |
|
{{Colour key|red}} |
|
{{Colour key|red|Example}} |
Example
|
{{Colour key|red|Example|Red areas}} |
Example
|
See also