Template:Composition bar/doc: Difference between revisions
Jump to navigation
Jump to search
Content added Content deleted
Metriximor (talk | contribs) m (60 revisions imported from wikipedia:Template:Composition_bar/doc) |
|||
| (34 intermediate revisions by 16 users not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{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. |
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 == |
== Usage == |
||
<nowiki>{{</nowiki>Composition bar|''amount''|''total''|''bar-color''|''options...''}} |
|||
; amount |
|||
:<code><nowiki>{{</nowiki>Composition bar|''amount''|''total''|''color''<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 |
|||
: (default is transparent) is the background color of the right part of the bar - a valid [[web colors|web color]]. |
|||
* ''color'' is a valid [[web colors|web color]], which can be specified either by name, as a [[hex triplet]] (#rrbbgg), or [[hex triplet]].<br />In the case of political parties, most will have their logo color avaiable in {{tld|political party/meta/color}} templates. |
|||
; 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 any 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 == |
== Examples == |
||
{| |
{| |
||
|- |
|- |
||
| Line 21: | Line 35: | ||
| {{Composition bar|50|100|red}} |
| {{Composition bar|50|100|red}} |
||
|- |
|- |
||
| style="font-size: 95%"| <code><nowiki>{{Composition bar|50|100|# |
| style="font-size: 95%"| <code><nowiki>{{Composition bar|50|100|red|background-color=#DDD|border=none}}</nowiki></code> |
||
| {{Composition bar|50|100|# |
| {{Composition bar|50|100|red|background-color=#DDD|border=none}} |
||
|- |
|||
| style="font-size: 95%"| <code><nowiki>{{Composition bar|50|100|#99F|width=85%}}</nowiki></code> |
|||
| {{Composition bar|50|100|#99F|width=85%}} |
|||
|- |
|- |
||
| style="font-size: 95%"| <code><nowiki>{{Composition bar|50|100|{{Green Party (UK)/meta/color}}}}</nowiki></code> |
| style="font-size: 95%"| <code><nowiki>{{Composition bar|50|100|{{Green Party (UK)/meta/color}}}}</nowiki></code> |
||
| Line 30: | Line 47: | ||
| {{Composition bar|50|100|rgb(255,255,16)}} |
| {{Composition bar|50|100|rgb(255,255,16)}} |
||
|- |
|- |
||
| style="font-size: 95%"| <code><nowiki>{{Composition bar|75|100|#FF0}}</nowiki></code> |
|||
| {{Composition bar|75|100|#FF0}} |
|||
|- |
|||
| style="font-size: 95%"| <code><nowiki>{{Composition bar|40|100|#F00|per=1}}</nowiki></code> |
|||
| {{Composition bar|40|100|#F00|per=1}} |
|||
|- |
|||
| style="font-size: 95%"| <code><nowiki>{{Composition bar|90|100|#F0F0F0|per=1|background-color=#F00}}</nowiki></code> |
|||
| {{Composition bar|90|100|#F0F0F0|per=1|background-color=#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 == |
== See also == |
||
* {{tl|Bartable}} |
|||
* {{tl|Bar chart}} |
* {{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> |
|||
Latest revision as of 21:11, 19 May 2021
 | 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 is used on approximately 7,100 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
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. 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
{{Composition bar|amount|total|bar-color|options...}}
- 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 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.
Additional display options:
- background-color=...
- (default is transparent) is the background color of the right part of the bar - a valid 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 any 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
| Code | Result |
|---|---|
{{Composition bar|50|100|red}}
|
50 / 100
|
{{Composition bar|50|100|red|background-color=#DDD|border=none}}
|
50 / 100
|
{{Composition bar|50|100|#99F|width=85%}}
|
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}}
|
75 / 100
|
{{Composition bar|40|100|#F00|per=1}}
|
40 / 100 (40%)
|
{{Composition bar|90|100|#F0F0F0|per=1|background-color=#F00}}
|
90 / 100 (90%)
|
{{Composition bar|90|100|#F0C|per=1}}
|
90 / 100 (90%)
|
{{Composition bar|0|26|hex=#00BFFF|per=1}}
|
0 / 26 (0%)
|
TemplateData
This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.
TemplateData for Composition bar
A composition bar.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| 1 | 1 | The number of sub-units. | Line | required |
| 2 | 2 | The total number of sub-units possible. | Line | required |
| 3 | 3 hex | 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.
| Line | optional |
| Background color | background-color | The background color of the right part of the bar - a valid web color.
| Line | optional |
| Border color | border border-color | The color of the border, or 'none' for no border
| Line | optional |
| Width | width | The width of the bar with units, such as 100% or 10em (unitless numbers are interpreted as px)
| Line | optional |
| Show percent | per | When set to 1 (true), adds a percentage to the bar as well
| Line | optional |
See also
Progress templates | |
|---|---|
| General progress templates |
|
| Specific-use templates |
|
