Template:Composition bar/doc: Difference between revisions
Jump to navigation
Jump to search
Content added Content deleted
(→Examples: add some examples of changing text and background colour) |
(→Usage: update documentation) |
||
| Line 6: | Line 6: | ||
== Usage == |
== Usage == |
||
:<code><nowiki>{{</nowiki>Composition bar|''amount''|''total''|''color''<nowiki>}}</nowiki></code> |
:<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 |
* ''amount'' is the number of sub-units |
||
* ''total'' is the total number of sub-units possible |
* ''total'' is the total number of sub-units possible |
||
* ''color'' is a valid [[web colors|web color]], which can be specified |
* ''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. |
* ''width'' is the width of the bar in px. |
||
* ''per'' adds a percentage to the bar as well. |
* ''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 parametr 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 == |
== Examples == |
||
Revision as of 22:28, 17 December 2013
 | This is a documentation subpage for Template:Composition bar. It contains usage information, categories and other content that is not part of the original template page. |
This template displays the numeric composition of a thing in terms of its sub-units. For example, it is frequently used as part of {{Infobox political party}} to show the number of seats a given political party holds in a legislature.
Usage
{{Composition bar|amount|total|bar-color|color=color|background-color=background-color|per=0/1}}
- 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 color, which can be specified by name, as a hex triplet (#rrbbgg), or rgb triplet (rgb(0–255,0–255,0–255)).
In the case of political parties, most will have their logo color available in{{political party/meta/color}}templates. - color (default is black) is the text colour - a valid web color.
- background-color (default is very light grey) is the background color of the right part of the bar - a valid 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 parametr may be used to provide a dark background for that part of the bar. See the first three examples below. Snook's Colour Contrast Check may be used to check compliance with WCAG guidelines for contrast.
Examples
| Code | Result |
|---|---|
{{Composition bar|50|100|red}}
|
50 / 100
|
{{Composition bar|50|100|red|color=#FFFFFF}}
|
50 / 100
|
{{Composition bar|50|100|red|color=#FFFFFF|background-color=#000000}}
|
50 / 100
|
{{Composition bar|50|100|#9999FF}}
|
50 / 100
|
{{Composition bar|50|100|{{Green Party (UK)/meta/color}}}}
|
50 / 100
|
{{Composition bar|50|100|rgb(255,255,16)}}
|
50 / 100
|
{{Composition bar|75|100|#FF0|width=250}}
|
75 / 100
|
{{Composition bar|90|100|#F00|width=500|per=1}}
|
90 / 100 (90%)
|
{{Composition bar|90|100|#F00|width=500|per=1|color=#FFFFFF}}
|
90 / 100 (90%)
|
See also
- {{Bar chart}}
- Template:T1
- {{Composition_bar/advanced}}
- {{Percentage bar}}
- {{Percent-done}}
- {{Progress}}
- {{Progress bar}}
- {{Progress box}}
- {{Progression}}
- {{Progress meter}}