Difference between revisions of "Template:Composition bar compact/doc"
imported>Matt Fitzpatrick (width "auto" hint) |
imported>Matt Fitzpatrick (updating for new default colors, width, border) |
||
| Line 12: | Line 12: | ||
: 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 medium 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. | + | : (default is medium-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 | + | : (default is light grey) is the background color of the right part of the bar - a valid [[web colors|web color]]. |
; color=... | ; color=... | ||
: (default is inherit) is the color of the text | : (default is inherit) is the color of the text | ||
; text-shadow=... | ; text-shadow=... | ||
: (default is white) is the color of the shadow around the text | : (default is white) is the color of the shadow around the text | ||
| − | ; border | + | ; border=... |
| − | : (default is | + | : (default is medium grey) is the color of a border around the bar, or "none" for no border |
; width=... | ; width=... | ||
| − | : (default is | + | : (default is 100px) is the width of the bar, set to "auto" for inline use, "100%" for most table uses (unitless numbers are interpreted as px) |
; 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 | ||
| Line 43: | Line 43: | ||
| {{Composition bar compact|50|100|darkred|color=#FFF|text-shadow=#000|background-color=#333}} | | {{Composition bar compact|50|100|darkred|color=#FFF|text-shadow=#000|background-color=#333}} | ||
|- | |- | ||
| − | | style="font-size: 95%"| <code><nowiki>{{Composition bar compact|50|100|#003|color=#FFF|text-shadow=#000|background-color=#333|border-color=# | + | | style="font-size: 95%"| <code><nowiki>{{Composition bar compact|50|100|#003|color=#FFF|text-shadow=#000|background-color=#333|border-color=#C33}}</nowiki></code> |
| − | | {{Composition bar compact|50|100|#003|color=#FFF|text-shadow=#000|background-color=#333|border-color=# | + | | {{Composition bar compact|50|100|#003|color=#FFF|text-shadow=#000|background-color=#333|border-color=#C33}} |
|- | |- | ||
| − | | style="font-size: 95%"| <code><nowiki>{{Composition bar compact|50|100|{{Green Party (UK)/meta/color}}}}</nowiki></code> | + | | style="font-size: 95%"| <code><nowiki>{{Composition bar compact|50|100|{{Green Party (UK)/meta/color}}|border=none}}</nowiki></code> |
| − | | {{Composition bar compact|50|100|{{Green Party (UK)/meta/color}}}} | + | | {{Composition bar compact|50|100|{{Green Party (UK)/meta/color}}|border=none}} |
|- | |- | ||
| style="font-size: 95%"| <code><nowiki>{{Composition bar compact|50|100|rgb(255,255,16)|width=auto}}</nowiki></code> | | style="font-size: 95%"| <code><nowiki>{{Composition bar compact|50|100|rgb(255,255,16)|width=auto}}</nowiki></code> | ||
| Line 87: | Line 87: | ||
"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": "#CCCCCC", |
"type": "string/line", | "type": "string/line", | ||
"required": false, | "required": false, | ||
| Line 95: | Line 95: | ||
"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": "#F0F0F0", |
"type": "string/line", | "type": "string/line", | ||
"required": false | "required": false | ||
| Line 109: | Line 109: | ||
"label": "Text shadow", | "label": "Text shadow", | ||
"description": "The color of the contrast shadow around the overlay text", | "description": "The color of the contrast shadow around the overlay text", | ||
| − | "default": "# | + | "default": "#FFFFFF", |
"type": "string/line", | "type": "string/line", | ||
"required": false | "required": false | ||
}, | }, | ||
| − | "border | + | "border": { |
| − | "label": " | + | "label": "Border color", |
| − | "description": " | + | "description": "Color of the border, or 'none' for no border", |
| − | "default": "", | + | "default": "#C0C0C0", |
"type": "string/line", | "type": "string/line", | ||
| − | "required": false | + | "required": false, |
| + | "aliases": ["border-color"] | ||
}, | }, | ||
"width": { | "width": { | ||
"label": "Width", | "label": "Width", | ||
| − | "description": "The width of the bar", | + | "description": "The width of the bar (unitless numbers are interpreted as px)", |
| − | "default": " | + | "default": "100px", |
"type": "string/line", | "type": "string/line", | ||
"required": false | "required": false | ||
Latest revision as of 06:36, 25 February 2017
| 40px | This is a documentation subpage for Template:Composition bar compact. 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. It is a one-line variation of the two-line, fixed width Template:Composition bar.
Contents
Usage
{{Composition bar compact|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 medium-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 light grey) is the background color of the right part of the bar - a valid web color.
- color=...
- (default is inherit) is the color of the text
- text-shadow=...
- (default is white) is the color of the shadow around the text
- border=...
- (default is medium grey) is the color of a border around the bar, or "none" for no border
- width=...
- (default is 100px) is the width of the bar, set to "auto" for inline use, "100%" for most table uses (unitless numbers are interpreted as px)
- per=...
- (default is false), when set to any value (true), adds a percentage to the bar as well
- perstyle=...
- (default is none), additional style declarations for the percentage text
Some older Web browsers do not render text-shadows, so the text should ideally have enough contrast on its own. If the bar color is dark, lighten the text color, and darken the background-color and text-shadow. See the second and third examples below. Snook's Colour Contrast Check may be used to check compliance with WCAG guidelines for contrast.
Examples
| Code | Result |
|---|---|
{{Composition bar compact|50|100|red}}
|
50 / 100 |
{{Composition bar compact|50|100|darkred|color=#FFF|text-shadow=#000|background-color=#333}}
|
50 / 100 |
{{Composition bar compact|50|100|#003|color=#FFF|text-shadow=#000|background-color=#333|border-color=#C33}}
|
50 / 100 |
{{Composition bar compact|50|100|{{Green Party (UK)/meta/color}}|border=none}}
|
50 / 100 |
{{Composition bar compact|50|100|rgb(255,255,16)|width=auto}}
|
50 / 100 |
{{Composition bar compact|75|100|#FF0|width=80%}}
|
75 / 100 |
{{Composition bar compact|40|100|#F00|per=1}}
|
40 / 100(Expression error: Unrecognized punctuation character "[".%) |
{{Composition bar compact|90|100|#F0F0F0|per=2|background-color=#F00}}
|
90 / 100(Expression error: Unrecognized punctuation character "[".%) |
{{Composition bar compact|90|100|#F0C|per=1}}
|
90 / 100(Expression error: Unrecognized punctuation character "[".%) |
TemplateData
TemplateData for Composition bar compact
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 |
| Text color | color | The color of the overlay text
| Line | optional |
| Text shadow | text-shadow | The color of the contrast shadow around the overlay text
| Line | optional |
| Border color | border border-color | Color of the border, or 'none' for no border
| Line | optional |
| Width | width | The width of the bar (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 |
| Percent style | perstyle | Style declarations for the percentage text
| Line | optional |
See also