Template:Legend/doc

This is a documentation subpage for Template:Legend.
It contains usage information, categories and other content that is not part of the original Template page.

Shows a legend row with a colored box.

Usage

{{legend|background-color|caption|outline=outline color|border=css border}}

background-color is passed to the css background-color property of the color box.
The optional outline parameter is the color of the outline around the box.
The optional border argument which overrides the outline argument and sets the css description (e.g., 1px solid #aaa) of the border that will be drawn around the box.

Examples

Use in text

{{legend|black|Africa}}
{{legend|green|Americas}}
{{legend|blue|Oceania}}
{{legend|#ffa|Europe|outline=silver}}
{{legend|#ff2800|Asia|outline=#A2A9B1}}  (#A2A9B1 is the wikitables border color.)

Africa

Americas

Oceania

Europe

Asia

Use in captions

Markup

Renders as

 [[File:Celts in Europe.png|upright=.9|thumb|right|The Celts in Europe, past and present:
 {{legend|#1a8000|Present-day Celtic-speaking areas}}
 {{legend|#27c600|Other parts of the six most commonly recognized "Celtic nations" and where a Celtic language is spoken but not the dominating language}}
 {{legend|#97ffb6|Other parts of Europe once peopled by Celts; modern-day inhabitants of many of these areas often claim a Celtic heritage and/or culture}}
 {{legend|#D2FFD2|Lusitanian area of Iberia, "Celticity" uncertain}}
 {{legend|yellow|The core Hallstatt territory, expansion before 500 BC}}
 ]]

Full parameter list

{{legend
| [legend box's colo(u)r]
| [text following legend box]
| outline =  <!--colo(u)r of border around legend box-->
| border =   <!--use to specify custom CSS styling for border (overrides 'outline')-->
| color =    <!--colo(u)r of 'text'-->
| size =     <!--'text' font-size-->
| text =     <!--to place text inside the legend box-->
}}

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Legend

Shows a legend row with a colored box and a caption.

Template parameters
Parameter		Description	Type	Status
Color	`1`	The color for the legend entry, in any CSS format Example "#6D6E00", "#ffa", "yellow"	Line	required
Caption	`2`	Label for the legend entry Example "soda" is most common	String	suggested
CSS border style	`border`	CSS style for the legend entry's border	String	optional
Entry outline	`outline`	CSS color for the outline of the legend entry Example silver	Line	optional
Text in the entry	`text`	Text to be displayed in the legend entry box, i.e. within the color specified Example Af	Line	optional
Text color	`textcolor`	CSS color of text inside the legend's colored box	String	optional
size	`size`	Size of the legend entry	String	optional