Template:Composition bar compact/doc: Difference between revisions

From TEPwiki, Urth's Encyclopedia
Jump to navigation Jump to search
Content added Content deleted
(default colors changed to dark text on light backgrounds)
 
(5 intermediate revisions by 2 users not shown)
Line 2: Line 2:
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]) -->
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]) -->


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. It is a one-line variation of the two-line [[Template:Composition bar]].
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. It is a one-line variation of the two-line, fixed width [[Template:Composition bar]].


== Usage ==
== Usage ==
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 {{party color|tld|political party}} templates.


Additional display options:
Additional display options:
; background-color=...
; background-color=...
: (default is very light grey) is the background color of the right part of the bar - a valid [[web colors|web color]].
: (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-color=...
; border=...
: (default is no border) is the color of a border around the bar
: (default is medium grey) is the color of a border around the bar, or "none" for no border
; width=...
; width=...
: (default is 100%) is the width of the bar
: (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=#336}}</nowiki></code>
| 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=#336}}
| {{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|{{party color|Green Party (UK)}}|border=none}}</nowiki></code>
| {{Composition bar compact|50|100|{{Green Party (UK)/meta/color}}}}
| {{Composition bar compact|50|100|{{party color|Green Party (UK)}}|border=none}}
|-
|-
| style="font-size: 95%"| <code><nowiki>{{Composition bar compact|50|100|rgb(255,255,16)}}</nowiki></code>
| style="font-size: 95%"| <code><nowiki>{{Composition bar compact|50|100|rgb(255,255,16)|width=auto}}</nowiki></code>
| {{Composition bar compact|50|100|rgb(255,255,16)}}
| {{Composition bar compact|50|100|rgb(255,255,16)|width=auto}}
|-
|-
| style="font-size: 95%"| <code><nowiki>{{Composition bar compact|75|100|#FF0|width=80%}}</nowiki></code>
| style="font-size: 95%"| <code><nowiki>{{Composition bar compact|75|100|#FF0|width=80%}}</nowiki></code>
Line 62: Line 62:
|-
|-
| style="font-size: 95%"| <code><nowiki>{{Composition bar compact|90|100|#F0C|per=1}}</nowiki></code>
| style="font-size: 95%"| <code><nowiki>{{Composition bar compact|90|100|#F0C|per=1}}</nowiki></code>
| {{Composition bar compact|90|100|#F0C|per=1|color=#FFF}}
| {{Composition bar compact|90|100|#F0C|per=1}}
|}
|}


Line 86: Line 86:
"3": {
"3": {
"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 {{party color|political party}} templates.",
"default": "#999",
"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": "#CCC",
"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": "#FFF",
"default": "#FFFFFF",
"type": "string/line",
"type": "string/line",
"required": false
"required": false
},
},
"border-color": {
"border": {
"label": "Show border color",
"label": "Border color",
"description": "Specify a color to add a border of that color; default state is no border",
"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": "100%",
"default": "100px",
"type": "string/line",
"type": "string/line",
"required": false
"required": false

Latest revision as of 03:10, 28 May 2022

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.

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 Lua error in package.lua at line 80: module 'Module:Political party/T' not found. 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}}
{{Composition bar compact|50|100|darkred|color=#FFF|text-shadow=#000|background-color=#333}}
{{Composition bar compact|50|100|#003|color=#FFF|text-shadow=#000|background-color=#333|border-color=#C33}}
{{Composition bar compact|50|100|{{party color|Green Party (UK)}}|border=none}} 50 / 100
{{Composition bar compact|50|100|rgb(255,255,16)|width=auto}}
{{Composition bar compact|75|100|#FF0|width=80%}}
{{Composition bar compact|40|100|#F00|per=1}}
{{Composition bar compact|90|100|#F0F0F0|per=2|background-color=#F00}}
{{Composition bar compact|90|100|#F0C|per=1}}

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Composition bar compact in articles based on its TemplateData.

TemplateData for Composition bar compact

A composition bar.

Template parameters

ParameterDescriptionTypeStatus
11

The number of sub-units.

Linerequired
22

The total number of sub-units possible.

Linerequired
33 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 {{party color|political party}} templates.

Default
#CCCCCC
Lineoptional
Background colorbackground-color

The background color of the right part of the bar - a valid web color.

Default
#F0F0F0
Lineoptional
Text colorcolor

The color of the overlay text

Default
inherit
Lineoptional
Text shadowtext-shadow

The color of the contrast shadow around the overlay text

Default
#FFFFFF
Lineoptional
Border colorborder border-color

Color of the border, or 'none' for no border

Default
#C0C0C0
Lineoptional
Widthwidth

The width of the bar (unitless numbers are interpreted as px)

Default
100px
Lineoptional
Show percentper

When set to 1 (true), adds a percentage to the bar as well

Default
0
Lineoptional
Percent styleperstyle

Style declarations for the percentage text

Default
Lineoptional

See also