View source for Template:Stacked bar/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

==Usage==
Makes a horizontal stacked chart of up to 12 counts (plus a gray bar if the total is greater than the sum of the 12). If no total is supplied, defaults to 100 (for percentages). By default, uses nice rainbow of colors that don't correspond to reserved article class or importance colors, but colors can be customized.

Article counts may be automatically calculated with the <code><nowiki>{{PAGESINCATEGORY}}</nowiki></code> magic word, e.g. <code><nowiki>{{PAGESINCATEGORY:FA-Class Square Enix articles|R}}</nowiki></code>

* <code>A#</code> variables: Amounts. Given as any plain number. No units permitted.
* <code>T#</code> variables: Optional titles. If no title is wanted, leave completely blank. (A &amp;nbsp; or similar is not helpful.)
* <code>C#</code> variables: Optional colour values as any valid CSS colour. Defaults to a rainbow-type progression
* <code>Total</code> Optional total amount. Given as any plain number. No units permitted. Defaults to 100.
* <code>height</code> Optional height of the bar. Given as a CSS length (px recommended). Defaults to 10.
* <code>vertical_caption</code>: If set to yes/true, have the labels use vertical text. If set to lean, tilts the text at an angle.
* <code>caption_height</code>: If the captions are vertical, their height is limited to this. Given as a CSS length, e.g. 8em or 200px.

{{cot|left=yes|title=TemplateData<div style="font-weight:normal">{{TemplateData header}}</div>}}
<templatedata>
{
	"params": {
		"vertical_caption": {
			"label": "Vertical caption",
			"description": "If set to yes/true, have the labels use vertical text.",
			"type": "boolean"
		},
		"caption_height": {
			"label": "Caption height limit",
			"description": "If the captions are vertical, their height is limited to this. Given as a CSS length.",
			"type": "string",
			"default": "8em"
		},
		"height": {
			"label": "Bar height",
			"description": "Height of the bar as a CSS length (px recommended).",
			"type": "string",
			"default": "Default is 10px; this is as thin as you would want to go."
		},
		"Total": {
			"label": "Total amount",
			"description": "Total amount that the bars sum to. Should be a number with no units.",
			"type": "number",
			"default": "Defaults to 100 so that percentages can be used as the amounts."
		},
		"T1": { "label": "Text 1", "type": "line", "suggested": true, "description": "Label of this item" },
		"A1": { "label": "Amount 1", "type": "number", "required": true, "description": "Amount of this item (plain number)" },
		"T2": { "label": "Text 2", "type": "line", "suggested": true, "description": "Label of this item" },
		"A2": { "label": "Amount 2", "type": "number", "required": true, "description": "Amount of this item (plain number)" },
		"T3": { "label": "Text 3", "type": "line", "suggested": true, "description": "Label of this item" },
		"A3": { "label": "Amount 3", "type": "number", "suggested": true, "description": "Amount of this item (plain number)" },
		"T4": { "label": "Text 4", "type": "line", "description": "Label of this item" },
		"A4": { "label": "Amount 4", "type": "number", "description": "Amount of this item (plain number)" },
		"T5": { "label": "Text 5", "type": "line", "description": "Label of this item" },
		"A5": { "label": "Amount 5", "type": "number", "description": "Amount of this item (plain number)" },
		"T6": { "label": "Text 6", "type": "line", "description": "Label of this item" },
		"A6": { "label": "Amount 6", "type": "number", "description": "Amount of this item (plain number)" },
		"T7": { "label": "Text 7", "type": "line", "description": "Label of this item" },
		"A7": { "label": "Amount 7", "type": "number", "description": "Amount of this item (plain number)" },
		"T8": { "label": "Text 8", "type": "line", "description": "Label of this item" },
		"A8": { "label": "Amount 8", "type": "number", "description": "Amount of this item (plain number)" },
		"T9": { "label": "Text 9", "type": "line", "description": "Label of this item" },
		"A9": { "label": "Amount 9", "type": "number", "description": "Amount of this item (plain number)" },
		"T10": { "label": "Text 10", "type": "line", "description": "Label of this item" },
		"A10": { "label": "Amount 10", "type": "number", "description": "Amount of this item (plain number)" },
		"T11": { "label": "Text 11", "type": "line", "description": "Label of this item" },
		"A11": { "label": "Amount 11", "type": "number", "description": "Amount of this item (plain number)" },
		"T12": { "label": "Text 12", "type": "line", "description": "Label of this item" },
		"A12": { "label": "Amount 12", "type": "number", "description": "Amount of this item (plain number)" },
		"C1": { "label": "Colour 1", "type": "string", "description": "CSS colour of this item" },
		"C2": { "label": "Colour 2", "type": "string", "description": "CSS colour of this item" },
		"C3": { "label": "Colour 3", "type": "string", "description": "CSS colour of this item" },
		"C4": { "label": "Colour 4", "type": "string", "description": "CSS colour of this item" },
		"C5": { "label": "Colour 5", "type": "string", "description": "CSS colour of this item" },
		"C6": { "label": "Colour 6", "type": "string", "description": "CSS colour of this item" },
		"C7": { "label": "Colour 7", "type": "string", "description": "CSS colour of this item" },
		"C8": { "label": "Colour 8", "type": "string", "description": "CSS colour of this item" },
		"C9": { "label": "Colour 9", "type": "string", "description": "CSS colour of this item" },
		"C10": { "label": "Colour 10", "type": "string", "description": "CSS colour of this item" },
		"C11": { "label": "Colour 11", "type": "string", "description": "CSS colour of this item" },
		"C12": { "label": "Colour 12", "type": "string", "description": "CSS colour of this item" }
	},
	"description": "Makes a horizontal stacked chart of up to 12 counts (plus a gray bar if the total is greater than the sum of the 12). If no total is supplied, defaults to 100 (for percentages). By default, uses nice rainbow of colors that don't correspond to reserved article class or importance colors, but colors can be customized.\n\nArticle counts may be automatically calculated with the {{PAGESINCATEGORY}} magic word, e.g. {{PAGESINCATEGORY:FA-Class Square Enix articles|R}}\n\n• A# variables: Amounts. Given as any plain number. No units permitted.\n• T# variables: Optional titles. If no title is wanted, leave completely blank. (An &nbsp; or similar is not helpful.\n• C# variables: Optional colour values as any valid CSS colour. Defaults to a rainbow-type progression",
	"format": "{{_\n|_=_ }}"
}
</templatedata>
{{cob}}

== Examples ==

; Video game good articles by arbitrary category
: <syntaxhighlight lang="text" inline>{{Stacked bar|A1=833|T1=Video games |A2=33|T2=Series |A3=94|T3=Characters |A4=99|T4=Development |A5=71|T5=Music |A6=29|T6=Media |A7=36|T7=Etc|C7=Black |Total=1195}}</syntaxhighlight>
: Note that if the width of the bar section is narrower than the width of the lables, then the labels push each other out of the way, harming readability. The final section has also been given a specified color, while the rest are left at defaults.
: {{Stacked bar|A1=833|T1=Video games|A2=33|T2=Series|A3=94|T3=Characters|A4=99|T4=Development|A5=71|T5=Music|A6=29|T6=Media|A7=36|T7=Etc|C7=Black|Total=1195}}
; Video game good articles with vertical text
: This is slightly harder to read, but will allow all but the narrowest categories to line up properly.
: <syntaxhighlight lang="text" inline>{{Stacked bar|vertical_caption=yes|A1=833|T1=Video games |A2=33|T2=Series |A3=94|T3=Characters |A4=99|T4=Development |A5=71|T5=Music |A6=29|T6=Media |A7=36|T7=Etc|C7=Black |Total=1195}}</syntaxhighlight>
: {{Stacked bar|vertical_caption=yes|A1=833|T1=Video games|A2=33|T2=Series|A3=94|T3=Characters|A4=99|T4=Development|A5=71|T5=Music|A6=29|T6=Media|A7=36|T7=Etc|C7=Black|Total=1195}}
; Number of video game articles in the 70s and earlier by year with a higher total than the sum
: Note that some labels are abbreviated to avoid displacement. Note also the gray area at the end, as the sum of the categories is less than the "Total" number.
: <syntaxhighlight lang="text" inline>{{Stacked bar|A1=13|T1=<1970s |A2=5|T2=71 |A3=4|T3=72 |A4=8|T4=73 |A5=7|T5=74 |A6=16|T6=1975 |A7=23|T7=1976 |A8=24|T8=1977 |A9=37|T9=1978 |A10=54|T10=1979 |Total=200}}</syntaxhighlight>
:{{Stacked bar|A1=13|T1=<1970s|A2=5|T2=71|A3=4|T3=72|A4=8|T4=73|A5=7|T5=74|A6=16|T6=1975|A7=23|T7=1976|A8=24|T8=1977|A9=37|T9=1978|A10=54|T10=1979|Total=200}}

;Video game good articles by year
:Note that some labels are skipped to avoid displacement
:<syntaxhighlight lang="text" inline>{{Stacked bar|A1=11|T1= |A2=17|T2= |A3=37|T3=<1985 |A4=83|T4=85–89 |A5=129|T5=1990–94 |A6=179|T6=1995–99 |A7=198|T7=2000–04 |A8=221|T8=2005–09 |A9=221|T9=2010–14 |A10=125|T10=2015–19 |A11=9|T11= |Total=1230}}</syntaxhighlight>
:{{Stacked bar |A1=11|T1= |A2=17|T2= |A3=37|T3=<1985 |A4=83|T4=85–89 |A5=129|T5=1990–94 |A6=179|T6=1995–99 |A7=198|T7=2000–04 |A8=221|T8=2005–09 |A9=221|T9=2010–14 |A10=125|T10=2015–19 |A11=9|T11= |Total=1230}}

;Leaning labels (vertical_caption=lean)
:Leaning labels, with a thicker bar, placed inside of an image frame. Note the line break in the final caption.
{{image frame|caption=<syntaxhighlight lang="moin" inline>{{Stacked bar | height=18px | vertical_caption=lean |T1=[[Intel]]|A1=13.1|C1=#0072c6 |T2=''None''|A2=8.2|C2=#ccc |T3=[[Red Hat]]|A3=7.2|C3=#e00 |T4=[[Linaro]]|A4=5.6|C4=#96c72e |T5=''Unknown''|A5=4.1|C5=#ccc |T6=[[IBM]]|A6=4.1|C6=#1870c0 |T7=''Consultants''|A7=3.3|C7=#ccc |T8=[[Samsung]]|A8=3.2|C8=#004da4 |T9=SUSE|A9=3|C9=#30BA78 |T10=Google|A10=3|C10=#fbbc05 |T11=''other<br/>companies''|A11=45.2|C11=#eee}}</syntaxhighlight>[https://www.linuxfoundation.org/publications/2017/10/2017-state-of-linux-kernel-development/]
|width=600
|content={{Stacked bar | height=18px | vertical_caption=lean |T1=[[Intel]]|A1=13.1|C1=#0072c6 |T2=''None''|A2=8.2|C2=#ccc |T3=[[Red Hat]]|A3=7.2|C3=#e00 |T4=[[Linaro]]|A4=5.6|C4=#96c72e |T5=''Unknown''|A5=4.1|C5=#ccc |T6=[[IBM]]|A6=4.1|C6=#1870c0 |T7=''Consultants''|A7=3.3|C7=#ccc |T8=[[Samsung]]|A8=3.2|C8=#004da4 |T9=SUSE|A9=3|C9=#30BA78 |T10=Google|A10=3|C10=#fbbc05 |T11=''other<br/>companies''|A11=45.2|C11=#eee}}
}}
{{clear}}

== See also ==
* {{tl|Progression rainbow}}, which has no option for captions and always uses article class colors

{{Progress templates}}

<includeonly>{{Sandbox other||
<!-- Categories and interwikis go here: -->
[[Category:Wikipedia utility templates]]
[[Category:Wikipedia progress templates]]
[[Category:Graph, chart and plot templates]]
}}</includeonly>