Template:Composition bar/doc: Difference between revisions

← Older edit

Template:Composition bar/doc (view source)

Revision as of 21:11, 19 May 2021

1,939 bytes added , 3 years ago

m

60 revisions imported from wikipedia:Template:Composition_bar/doc

VisualWikitext

Metriximor

Autopatrolled users, Bureaucrats, Confirmed users, Rollbackers, Administrators

3,060

edits

Revision as of 22:29, 17 December 2013 (view source) wikipedia>RexxS m (→‎Usage: sp) ← Older edit		Latest revision as of 21:11, 19 May 2021 (view source) Metriximor (talk \| contribs) m (60 revisions imported from wikipedia:Template:Composition_bar/doc)
(29 intermediate revisions by 14 users not shown)
Line 1: {{Documentation subpage}} <!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> ~~<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->~~ {{high-use\| 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''\|''options...''}} ; amount ~~:<code><nowiki>{{</nowiki>Composition bar\|''amount''\|''total''\|''bar-color''\|color=''color''\|background-color=''background-color''\|per=0/1<nowiki>}}</nowiki></code>~~ : 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 {{tlc\|political party/meta/color}} templates. Additional display options: * ''amount'' is the number of sub-units ; background-color=... * ''total'' is the total number of sub-units possible * ''bar-color'': (default is ~~light grey~~transparent) is the background color of the ~~left~~right 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. ; border=... * ''color'' (default is black) is the text colour - a valid [[web colors\|web color]]. * ''background-color'': (default is ~~very light~~medium grey) is the ~~background~~ color of the ~~right~~border, ~~part~~or of"none" ~~the~~for ~~bar~~no ~~- a valid [[web colors\|web color]].~~border ; width=... * ''width'' is the width of the bar in px. * ''per'': (default is ~~false~~100px), ~~when~~a ~~set~~width tovalue 1for ~~(true)~~the bar, ~~adds~~such aas ~~percentage~~"100%" toor ~~the~~"8em" ~~bar~~(unitless numbers are interpreted as ~~well.~~px) ; per=... : (default is false), when set to any value (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. ; ref=... : (default is blank), may be used to add a reference/citation for the numbers. == Examples == {\| \|- Line 27 ⟶ 35: \| {{Composition bar\|50\|100\|red}} \|- \| style="font-size: 95%"\| <code><nowiki>{{Composition bar\|50\|100\|red\|background-color=#~~FFFFFF~~DDD\|border=none}}</nowiki></code> \| {{Composition bar\|50\|100\|red\|background-color=#~~FFFFFF~~DDD\|border=none}} \|- \| style="font-size: 95%"\| <code><nowiki>{{Composition bar\|50\|100\|~~red\|color=~~#~~FFFFFF~~99F\|~~background-color~~width=~~#000000~~85%}}</nowiki></code> \| {{Composition bar\|50\|100\|~~red\|color=~~#~~FFFFFF~~99F\|~~background-color~~width=~~#000000~~85%}} \|- ~~\| style="font-size: 95%"\| <code><nowiki>{{Composition bar\|50\|100\|#9999FF}}</nowiki></code>~~ ~~\| {{Composition bar\|50\|100\|#9999FF}}~~ \|- \| style="font-size: 95%"\| <code><nowiki>{{Composition bar\|50\|100\|{{Green Party (UK)/meta/color}}}}</nowiki></code> Line 42 ⟶ 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\|9040\|100\|#F00~~\|width=500~~\|per=1}}</nowiki></code> \| {{Composition bar\|9040\|100\|#F00~~\|width=500~~\|per=1}} \|- \| style="font-size: 95%"\| <code><nowiki>{{Composition bar\|90\|100\|#~~F00\|width=500~~F0F0F0\|per=1\|background-color=#~~FFFFFF~~F00}}</nowiki></code> \| {{Composition bar\|90\|100\|#~~F00\|width=500~~F0F0F0\|per=1\|background-color=#~~FFFFFF~~F00}} \|- \| style="font-size: 95%"\| <code><nowiki>{{Composition bar\|90\|100\|#F0C\|per=1}}</nowiki></code> \| {{Composition bar\|90\|100\|#F0C\|per=1}} \|- \| style="font-size: 95%"\| <code><nowiki>{{Composition bar\|0\|26\|hex=#00BFFF\|per=1}}</nowiki></code> \| {{Composition bar\|0\|26\|hex=#00BFFF\|per=1}} \|} == TemplateData == {{TemplateDataHeader}} <templatedata> { "description": "A composition bar.", "params": { "1": { "label": "1", "description": "The number of sub-units.", "type": "string/line", "required": true }, "2": { "label": "2", "description": "The total number of sub-units possible.", "type": "string/line", "required": true }, "3": { "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": "#CCCCCC", "type": "string/line", "required": false, "aliases": ["hex"] }, "background-color": { "label": "Background color", "description": "The background color of the right part of the bar - a valid web color.", "default": "transparent", "type": "string/line", "required": false }, "border": { "label": "Border color", "description": "The color of the border, or '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 }, "per": { "label": "Show percent", "description": "When set to 1 (true), adds a percentage to the bar as well", "default": "0", "type": "string/line", "required": false } } } </templatedata> == See also == * {{tl\|Bartable}} * {{tl\|Bar chart}} * {{t1\|Backlog progress bar}} * {{tl\|Composition_bar/advanced}} * {{tl\|Percentage bar}} * {{tl\|Percent-done}} * {{tl\|Progress}} * {{tl\|Progress bar}} * {{tl\|Progress box}} * {{tl\|Progression}} * {{tl\|Progress meter}} {{Progress templates}} ~~<includeonly>~~ ~~<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->~~ <includeonly>{{When on basepage ~~[[Category:Template implementation details]]~~ \| <!-- Categories below this line; interwikis at Wikidata --> ~~[[Category:Graphic templates]]~~ [[Category:Chart, diagram and graph templates]] ~~</includeonly>~~ [[Category:Wikipedia progress templates]] }}</includeonly>