Template:Composition bar/doc: Difference between revisions

rm colour options
(update to High use template)
(rm colour options)
Line 6:
 
== Usage ==
:<code> <nowiki>{{</nowiki>Composition bar|''amount''|''total''|''bar-color''|color=''color''|background-color=''background-color''|per=0/1<nowiki>}}</nowiki></code>
 
; amount
:<code><nowiki>{{</nowiki>Composition bar|''amount''|''total''|''bar-color''|color=''color''|background-color=''background-color''|per=0/1<nowiki>}}</nowiki></code>
* ''amount'': is the number of sub-units
; total
* ''total'': is the total number of sub-units possible
; bar-color
* ''bar-color'': (default is light grey) is the background color of the left part of the bar - a valid [[web colors|web color]], which can be specified by name, as a [[hex triplet]] (#rrbbgg), or rgb triplet (rgb(0–255,0–255,0–255)).<br />In the case of political parties, most will have their logo color available in {{tld|political party/meta/color}} templates.
; background-color
* ''background-color'': (default is very light grey) is the background color of the right part of the bar - a valid [[web colors|web color]].
; width
* ''width'': is the width of the bar in px.
; per
* ''per'': (default is false), when set to 1 (true), adds a percentage to the bar as well.
 
If the bar-colour is dark, then the text may have insufficient contrast to show clearly for some readers. The text colour may be changed to white by specifying the color parameter. The background colour for the right part of the bar may then be too light to give sufficient contrast with white text, in which case the background-color parameter may be used to provide a dark background for that part of the bar. See the first three examples below. [http://snook.ca/technical/colour_contrast/colour.html Snook's Colour Contrast Check] may be used to check compliance with [[WCAG]] guidelines for contrast.
* ''amount'' is the number of sub-units
* ''total'' is the total number of sub-units possible
* ''bar-color'' (default is light grey) is the background color of the left part of the bar - a valid [[web colors|web color]], which can be specified by name, as a [[hex triplet]] (#rrbbgg), or rgb triplet (rgb(0–255,0–255,0–255)).<br />In the case of political parties, most will have their logo color available in {{tld|political party/meta/color}} templates.
* ''color'' (default is black) is the text colour - a valid [[web colors|web color]].
* ''background-color'' (default is very light grey) is the background color of the right part of the bar - a valid [[web colors|web color]].
* ''width'' is the width of the bar in px.
* ''per'' (default is false), when set to 1 (true), adds a percentage to the bar as well.
 
If the bar-colour is dark, then the text may have insufficient contrast to show clearly for some readers. The text colour may be changed to white by specifying the color parameter. The background colour for the right part of the bar may then be too light to give sufficient contrast with white text, in which case the background-color parameter may be used to provide a dark background for that part of the bar. See the first three examples below. [http://snook.ca/technical/colour_contrast/colour.html Snook's Colour Contrast Check] may be used to check compliance with [[WCAG]] guidelines for contrast.
 
== Examples ==
 
{|
|-
Line 52 ⟶ 55:
| {{Composition bar|90|100|#F0F0F0|width=300|per=2|background-color=#F00}}
|-
| style="font-size: 95%"| <code><nowiki>{{Composition bar|90|100|#F0C|width=300|per=1|color=#FFF}}</nowiki></code>
| {{Composition bar|90|100|#F0C|width=300|per=1|color=#FFF}}
|}
Line 60 ⟶ 63:
 
<templatedata>
 
{
"description": "A composition bar.",
Line 83 ⟶ 85:
"required": false,
"aliases": ["hex"],
},
"Text color": {
"label": "color",
"description": "The text colour - a valid web color.",
"default": "#000",
"type": "string/line",
"required": false
},
"Background color": {
Line 109 ⟶ 104:
"description": "When set to 1 (true), adds a percentage to the bar as well.",
"default": "0",
"type": "string/line",
"required": false
},
"Border width": {
"label": "border-width",
"description": "Determines the thickness of the border around the box in px.",
"default": "1px",
"type": "string/line",
"required": false
},
"Border color": {
"label": "border-color",
"description": "Determines the color of the border around the box - a valid web color.",
"default": "#C0C0C0",
"type": "string/line",
"required": false
Line 128 ⟶ 109:
}
}
 
</templatedata>
 
Anonymous user