Template:Composition bar compact/doc

From TSP Encyclopedia
Revision as of 16:55, 14 May 2024 by Anjo (talk | contribs) (Copied from Wikipedia)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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 Template:Party 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}}
{{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}}
{{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

Template:Progress templates