Difference between revisions of "Template:Colour key/doc"

From blackwiki
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": "Alternative name of the colour",
+
                 "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>. 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 ''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


Template:TemplateData

Displaying a colour key

Template parameters

ParameterDescriptionTypeStatus
Colour1

Colour code of the area

Default
black
Stringoptional
Description2

Explanation of the meaning of the colour

Stringoptional
Colour name3

Name of the colour if not standard

Stringoptional

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