Template:Bar box/doc

This is a documentation subpage for Template:Bar box.
It may contain usage information, categories and other content that is not part of the original template page.

{{bar box}}, {{bar percent}} and {{bar pixel}} are a family of templates for construction of horizontal bar charts.

Examples

See talk.

Usage

{{Bar box
|width   =  width of the graph (optional)
|barwidth=  width of the bararea (optional, defaults to 100px)
|float   =  (left|right|none) (optional, defaults to none)
|title   =  title of the chart (optional)
|titlebar=  title bar colour (optional, defaults to none)
|left1   =  first left column header (optional)
|left2   =  second left column header (optional)
|right1  =  first right column header (optional)
|right2  =  second right column header (optional)
|bars    =  chart contents(see below)
|caption =  caption under the chart   (optional)}
}}

Chart contents

Bar box can contain any number of bars. There are two types of bars:

Percentage bar:

{{bar percent|row label|colour|value (width in percents)|optional value label}}

If value label is not provided, it is constructed from the percentage and "%".

Pixel bar:

{{bar pixel|row label|colour|value (width in pixels)|value suffix|optional value label}}

If value label is provided, value suffix is ignored. Otherwise, the value label is constructed from the value and the value suffix. This is used as shorthand. Both following examples give identical results:

{{bar pixel|foo|red|12||12,345}}
{{bar pixel|foo|red|12|3,45}}