Template:Legend

Template documentation[view] [edit] [history] [purge]

This template is used on approximately 35,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses TemplateStyles:

Template:Legend/styles.css

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:
<div class="legend"><span class="legend-color mw-no-invert" style="background-color:#1a8000; color:white;"> </span> Present-day Celtic-speaking areas</div>
<div class="legend"><span class="legend-color mw-no-invert" style="background-color:#27c600; color:black;"> </span> Other parts of the six most commonly recognized "Celtic nations" and where a Celtic language is spoken but not the dominating language</div>
<div class="legend"><span class="legend-color mw-no-invert" style="background-color:#97ffb6; color:black;"> </span> Other parts of Europe once peopled by Celts; modern-day inhabitants of many of these areas often claim a Celtic heritage and/or culture</div>
<div class="legend"><span class="legend-color mw-no-invert" style="background-color:#D2FFD2; color:black;"> </span> Lusitanian area of Iberia, "Celticity" uncertain</div>
<div class="legend"><span class="legend-color mw-no-invert" style="background-color:yellow; color:black;"> </span> The core Hallstatt territory, expansion before 500 BC</div>]]

Use with all parameters

green The meadow is green.

</syntaxhighlight>

green The meadow is green.

Full parameter list

[text following legend box]

</syntaxhighlight>

Limitations

Using certain special characters in |text= that have meaning in wikitext can cause unexpected results. To use * in |text=, use |text={{asterisk}}. To use # in |text=, use |text={{number sign}}.

TemplateData

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

TemplateData for 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`	Font size of the legend entry, including colored box	String	optional

The above documentation is transcluded from Template:Legend/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.