Template:Legend

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

Shows a legend row with a colored box.

Usage

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

• 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. Not to be confused with the CSS outline property.
• The optional border argument which overrides the outline argument and sets the CSS property (e.g., 1px solid #aaa) of the border that will be drawn around the box.

Examples

Use in text

{{legend|black|Africa|outline=gray}}
{{legend|green|Americas}}
{{legend|blue|Oceania}}
{{legend|#ffa|Europe|outline=silver}}
{{legend|#ff2800|Asia|outline=#A2A9B1}}
<!-- #A2A9B1 is the [[Help:Basic table markup|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}} ]]

The Celts in Europe, past and present:   Present-day Celtic-speaking areas   Other parts of the six most commonly recognized "Celtic nations" and where a Celtic language is spoken but not the dominating language   Other parts of Europe once peopled by Celts; modern-day inhabitants of many of these areas often claim a Celtic heritage and/or culture   Lusitanian area of Iberia, "Celticity" uncertain   The core Hallstatt territory, expansion before 500 BC

Use with all parameters except alt and invert

{{legend
| #aea<!--light green-->
| Agricultural meadow
| outline   = #00e <!--blue >> will be not used because overridden by border-parameter-->
| border    = 2px solid #e00 <!--red-->
| textcolor = #00e <!--blue-->
| size      = 200%
| text      = A
}}

A  Agricultural meadow

Invert in dark mode

{{legend|#FFC7C7|No|invert=yes}}
{{legend|#F2EC9B|Maybe|invert=yes}}
{{legend|#9EFF9E|Yes|invert=yes}}

  No

  Maybe

  Yes

Full parameter list

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

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}}.

Determine hex colors for legend

One way to determine the exact color is via freeware IrfanView. Open image. Then:

Edit menu > Show Paint dialog > click on the eyedropper > click somewhere in the image > click on the color at the bottom of the Paint dialog > Write down the Red, Green, and Blue color numbers (RGB).

Online sites that can identify the color of any pixel in an uploaded image are also available:

• imagecolorpicker.com

Convert RGB colors to hex color or color name (if there is one):

• Color Converter.

See also

• Variant blocks
  • {{legend striped}}, two colors, for striped color areas
  • {{legend inline}}, uses display:inline to avoid line breaks after each legend
  • {{legend0}}, without the line-feed
  • {{leftlegend}}, with text-align set to left
  • {{color box}} and {{RouteBox}}, with text placed inside the colored legend and article linking
• {{legend-line}}, legends for lines such as graphs, charts, diagrams, and borders on maps
• {{image key}}, allows legend templates being used in image captions to use multiple columns

• Lists of colors
• Web colors

Templates that list colors

• {{Colornames}}
• {{X11 color chart}}
• {{Web Colors}}

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
Invert in dark mode	invert	Invert color swatch and its contents in dark mode (recommended for tables)	String	optional
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
Alt text of the entry	alt	Adds hidden text to the legend entry box; overrides "text" 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. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.