Template:Composition bar/doc: Difference between revisions

m
60 revisions imported from wikipedia:Template:Composition_bar/doc
mNo edit summary
m (60 revisions imported from wikipedia:Template:Composition_bar/doc)
 
(12 intermediate revisions by 6 users not shown)
Line 1:
{{Documentation subpage}}
<!-- CategoriesAdd gocategories where indicated at the bottom of this page, please;and interwikis go to Wikidata (see also:at [[Wikipedia:Wikidata]]) -->
{{high-use| 4,200+4913 }}
 
This template displays the numeric composition of a thing in terms of its sub-units. For example, it is frequently used as part of {{tl|Infobox political party}} to show the number of seats a given political party holds in a legislature. A single line, flexible width version of this template is available at [[Template:Composition bar compact]]. A textless, single line, flexible width version of this template is available at [[Template:Composition bar textless]].
 
== Usage ==
<nowiki>{{</nowiki>Composition bar|''amount''|''total''|''bar-color''|background-color=''background-coloroptions...''|per=0/1}}
 
; amount
: The first parameter is the number of sub-units.
; total
: The second parameter is the total number of sub-units possible.
; bar-color
: (default is light grey) The third parameter 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 {{tldtlc|political party/meta/color}} templates.
; 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.
 
Additional display options:
The background colour for the right part of the bar may then be too light to give sufficient contrast, 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.
; background-color=...
: (default is very light greytransparent) is the background color of the right part of the bar - a valid [[web colors|web color]].
; border=...
: (default is medium grey) is the color of the border, or "none" for no border
; width=...
: (default is 100px) a width value for the bar, such as "100%" or "8em" (unitless numbers are interpreted as px)
; per=...
: (default is false), when set to 1any value (true), adds a percentage to the bar as well.
; ref=...
: (default is blank), may be used to add a reference/citation for the numbers.
 
== Examples ==
Line 31 ⟶ 35:
| {{Composition bar|50|100|red}}
|-
| style="font-size: 95%"| <code><nowiki>{{Composition bar|50|100|red|background-color=#FFFDDD|border=none}}</nowiki></code>
| {{Composition bar|50|100|red|background-color=#FFFDDD|border=none}}
|-
| style="font-size: 95%"| <code><nowiki>{{Composition bar|50|100|red|color=#FFF99F|background-colorwidth=#00085%}}</nowiki></code>
| {{Composition bar|50|100|red|color=#FFF99F|background-colorwidth=#00085%}}
|-
| style="font-size: 95%"| <code><nowiki>{{Composition bar|50|100|#99F}}</nowiki></code>
| {{Composition bar|50|100|#99F}}
|-
| style="font-size: 95%"| <code><nowiki>{{Composition bar|50|100|{{Green Party (UK)/meta/color}}}}</nowiki></code>
Line 46 ⟶ 47:
| {{Composition bar|50|100|rgb(255,255,16)}}
|-
| style="font-size: 95%"| <code><nowiki>{{Composition bar|75|100|#FF0|width=250}}</nowiki></code>
| {{Composition bar|75|100|#FF0|width=250}}
|-
| style="font-size: 95%"| <code><nowiki>{{Composition bar|40|100|#F00|width=300|per=1}}</nowiki></code>
| {{Composition bar|40|100|#F00|width=300|per=1}}
|-
| style="font-size: 95%"| <code><nowiki>{{Composition bar|90|100|#F0F0F0|width=300|per=21|background-color=#F00}}</nowiki></code>
| {{Composition bar|90|100|#F0F0F0|width=300|per=21|background-color=#F00}}
|-
| style="font-size: 95%"| <code><nowiki>{{Composition bar|90|100|#F0C|width=300|per=1}}</nowiki></code>
| {{Composition bar|90|100|#F0C|width=300|per=1|color=#FFF}}
|-
| style="font-size: 95%"| <code><nowiki>{{Composition bar|500|10026|hex=#99F00BFFF|per=1}}</nowiki></code>
| {{Composition bar|500|10026|hex=#99F00BFFF|per=1}}
|}
 
Line 81 ⟶ 85:
"label": "3",
"description": "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.",
"default": "#CCCCCCCCC",
"type": "string/line",
"required": false,
"aliases": ["hex"],
},
"Background background-color": {
"label": "background-Background color",
"description": "The background color of the right part of the bar - a valid web color.",
"default": "#F0F0F0transparent",
"type": "string/line",
"required": false
},
"Widthborder": {
"label": "widthBorder color",
"description": "The widthcolor of the barborder, inor px.'none' for no border",
"default": "#AAAAAA",
"type": "string/line",
"required": false,
"aliases": ["border-color"]
},
"width": {
"label": "Width",
"description": "The width of the bar with units, such as 100% or 10em (unitless numbers are interpreted as px)",
"default": "100px",
"type": "string/line",
"required": false
},
"Show Percentper": {
"label": "perShow percent",
"description": "When set to 1 (true), adds a percentage to the bar as well.",
"default": "0",
"type": "string/line",
Line 118 ⟶ 130:
 
<includeonly>{{When on basepage
| <!-- Categories go below this line, please; interwikis go toat Wikidata, thank you! -->
[[Category:Chart, diagram and graph templates]]
[[Category:Wikipedia progress templates]]