Difference between revisions of "Template:Composition bar/doc"
imported>Matt Fitzpatrick (updated templatedata) |
imported>Matt Fitzpatrick (updating again, template reverted to 2015 version) |
||
| Line 3: | Line 3: | ||
{{high-use| 4913 }} | {{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 version of this template is available at [[Template:Composition bar compact]]. |
== Usage == | == Usage == | ||
| Line 13: | Line 13: | ||
: The second parameter is the total number of sub-units possible. | : The second parameter is the total number of sub-units possible. | ||
; bar-color | ; bar-color | ||
| − | : (default is | + | : (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 {{tld|political party/meta/color}} templates. |
Additional display options: | Additional display options: | ||
; background-color=... | ; background-color=... | ||
: (default is medium-dark grey) is the background color of the right part of the bar - a valid [[web colors|web color]]. | : (default is medium-dark grey) is the background color of the right part of the bar - a valid [[web colors|web color]]. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
; width=... | ; width=... | ||
: (default is 100%) is the width of the bar | : (default is 100%) is the width of the bar | ||
; per=... | ; per=... | ||
: (default is false), when set to any value (true), adds a percentage to the bar as well | : (default is false), when set to any value (true), adds a percentage to the bar as well | ||
| − | |||
| − | |||
| − | |||
| − | |||
== Examples == | == Examples == | ||
| Line 41: | Line 31: | ||
| {{Composition bar|50|100|red}} | | {{Composition bar|50|100|red}} | ||
|- | |- | ||
| − | | style="font-size: 95%"| <code><nowiki>{{Composition bar|50|100|pink | + | | style="font-size: 95%"| <code><nowiki>{{Composition bar|50|100|pink|background-color=#333}}</nowiki></code> |
| − | | {{Composition bar|50|100|pink | + | | {{Composition bar|50|100|pink|background-color=#333}} |
|- | |- | ||
| − | | style="font-size: 95%"| <code><nowiki>{{Composition bar|50|100|#99F | + | | style="font-size: 95%"| <code><nowiki>{{Composition bar|50|100|#99F}}</nowiki></code> |
| − | | {{Composition bar|50|100|#99F | + | | {{Composition bar|50|100|#99F}} |
|- | |- | ||
| 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 53: | Line 43: | ||
| {{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 | + | | style="font-size: 95%"| <code><nowiki>{{Composition bar|75|100|#FF0}}</nowiki></code> |
| − | | {{Composition bar|75|100|#FF0 | + | | {{Composition bar|75|100|#FF0}} |
|- | |- | ||
| style="font-size: 95%"| <code><nowiki>{{Composition bar|40|100|#F00|per=1}}</nowiki></code> | | style="font-size: 95%"| <code><nowiki>{{Composition bar|40|100|#F00|per=1}}</nowiki></code> | ||
| {{Composition bar|40|100|#F00|per=1}} | | {{Composition bar|40|100|#F00|per=1}} | ||
|- | |- | ||
| − | | style="font-size: 95%"| <code><nowiki>{{Composition bar|90|100|#F0F0F0|per= | + | | style="font-size: 95%"| <code><nowiki>{{Composition bar|90|100|#F0F0F0|per=1|background-color=#F00}}</nowiki></code> |
| − | | {{Composition bar|90|100|#F0F0F0|per= | + | | {{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> | | style="font-size: 95%"| <code><nowiki>{{Composition bar|90|100|#F0C|per=1}}</nowiki></code> | ||
| − | | {{Composition bar|90|100|#F0C|per=1 | + | | {{Composition bar|90|100|#F0C|per=1}} |
|} | |} | ||
| Line 88: | Line 78: | ||
"label": "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.", | "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": "# | + | "default": "#CCC", |
"type": "string/line", | "type": "string/line", | ||
"required": false, | "required": false, | ||
| Line 96: | Line 86: | ||
"label": "Background color", | "label": "Background color", | ||
"description": "The background color of the right part of the bar - a valid web color.", | "description": "The background color of the right part of the bar - a valid web color.", | ||
| − | "default": " | + | "default": "transparent", |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
"type": "string/line", | "type": "string/line", | ||
"required": false | "required": false | ||
| Line 123: | Line 92: | ||
"width": { | "width": { | ||
"label": "Width", | "label": "Width", | ||
| − | "description": "The width of the bar", | + | "description": "The width of the bar in px (fixed width only, relative widths do not work)", |
| − | "default": "100 | + | "default": "100", |
"type": "string/line", | "type": "string/line", | ||
"required": false | "required": false | ||
| Line 132: | Line 101: | ||
"description": "When set to 1 (true), adds a percentage to the bar as well", | "description": "When set to 1 (true), adds a percentage to the bar as well", | ||
"default": "0", | "default": "0", | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
"type": "string/line", | "type": "string/line", | ||
"required": false | "required": false | ||
Revision as of 04:19, 24 February 2017
| 40px | 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. |
| 40px | This template is used on approximately 7,700 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.
Transclusion count updated automatically (see documentation). |
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 version of this template is available at Template:Composition bar compact.
Contents
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 medium-dark grey) is the background color of the right part of the bar - a valid web color.
- width=...
- (default is 100%) is the width of the bar
- per=...
- (default is false), when set to any value (true), adds a percentage to the bar as well
Examples
| Code | Result |
|---|---|
{{Composition bar|50|100|red}}
|
50 / 100
<div style="background-color: red; width: Expression error: Unrecognized punctuation character "[".%; height: 100%;"> |
{{Composition bar|50|100|pink|background-color=#333}}
|
50 / 100
<div style="background-color: pink; width: Expression error: Unrecognized punctuation character "[".%; height: 100%;"> |
{{Composition bar|50|100|#99F}}
|
50 / 100
<div style="background-color:
|
{{Composition bar|50|100|{{Green Party (UK)/meta/color}}}}
|
50 / 100
<div style="background-color: #528D6B; width: Expression error: Unrecognized punctuation character "[".%; height: 100%;"> |
{{Composition bar|50|100|rgb(255,255,16)}}
|
50 / 100
<div style="background-color: rgb(255,255,16); width: Expression error: Unrecognized punctuation character "[".%; height: 100%;"> |
{{Composition bar|75|100|#FF0}}
|
75 / 100
<div style="background-color:
|
{{Composition bar|40|100|#F00|per=1}}
|
40 / 100 (Expression error: Unrecognized punctuation character "[".%)
<div style="background-color:
|
{{Composition bar|90|100|#F0F0F0|per=1|background-color=#F00}}
|
90 / 100 (Expression error: Unrecognized punctuation character "[".%)
<div style="background-color:
|
{{Composition bar|90|100|#F0C|per=1}}
|
90 / 100 (Expression error: Unrecognized punctuation character "[".%)
<div style="background-color:
|
TemplateData
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 |
| Width | width | The width of the bar in px (fixed width only, relative widths do not work)
| Line | optional |
| Show percent | per | When set to 1 (true), adds a percentage to the bar as well
| Line | optional |
See also