|
<includeonly><div class="legend" style="-webkit-column-break-inside: avoid;page-break-inside: avoid;break-inside: avoid-column"><span class="legend-color" style="display:inline-block; width:1.5em; height:1.5em; margin:1px 0; border:{{{Annotation|{{{border|1px solid {{{outline|black}}}}}}}}}; background-color:{{Trimtrim|{{{1|transparent}}}}}; color:{{{textcolor|black}}}; font-size:{{{size|90100%}}}; text-align:center;">{{#if:{{{text|}}}|<span class="legend-text" style="font-size:95%;">{{{text}}}</span>| }}</span> {{{2|}}}</div></includeonly><noinclude>
{{Documentation}}
<noinclude>
{{Tumlin}}
[[Taggayt:Legend template]]
</noinclude>
==Usage==
<nowiki>{{</nowiki>legend|''background-color''|''caption''|outline=''outline color''|border=''css border''<nowiki>}}</nowiki>
*''background-color'' is passed to the [[Cascading Style Sheets|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., <code>1px solid #aaa</code>) of the border that will be drawn around the box.
==Examples==
===Use in text===
<nowiki>{{legend|black|Africa}}</nowiki>
<nowiki>{{legend|green|Americas}}</nowiki>
<nowiki>{{legend|blue|Oceania}}</nowiki>
<nowiki>{{legend|#ffa|Europe|outline=silver}}</nowiki>
<nowiki>{{legend|#ff2800|Asia|outline=#A2A9B1}}</nowiki> <small><span style="color:gray">''(#A2A9B1 is the [[Help:Basic table markup|wikitables]] border color.)''</span></small>
{{legend|black|Africa}}
{{legend|green|Americas}}
{{legend|blue|Oceania}}
{{legend|#ffa|Europe|outline=silver}}
{{legend|#ff2800|Asia|outline=#A2A9B1}}
===Use in captions===
{{markup|<nowiki>
[[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}}
]]
</nowiki>|
[[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==
<pre>
{{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-->
}}
</pre>
==See also==
*Variant blocks
**{{tl|legend striped}}, two colors, for striped color areas
**{{tl|legend inline}}, uses ''display:inline'' to avoid line breaks after each legend
**{{tl|legend0}}, without the line-feed
**{{tl|legend2}}, without block formatting
**{{tl|legend4}}, with indented block formatting
**{{tl|leftlegend}}, with text-align set to left
**{{tl|color box}} and {{tl|RouteBox}}, with text placed inside the colored legend and article linking
*{{tl|legend-line}}, legends for lines
*[[Web colors]]
<includeonly>{{Sandbox other|
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:Legend templates]]
}}</includeonly>
==TemplateData==
{{TemplateData header}}
<templatedata>
{
"params": {
"1": {
"label": "Color",
"description": "The color for the legend entry, in any CSS format",
"example": "\"#6D6E00\", \"#ffa\", \"yellow\"",
"type": "line",
"required": true
},
"2": {
"label": "Caption",
"description": "Label for the legend entry",
"example": "\"soda\" is most common",
"type": "string",
"suggested": true
},
"border": {
"label": "CSS border style",
"description": "CSS style for the legend entry's border",
"type": "string"
},
"outline": {
"label": "Entry outline",
"description": "CSS color for the outline of the legend entry",
"example": "silver",
"type": "line"
},
"text": {
"label": "Text in the entry",
"description": "Text to be displayed in the legend entry box, i.e. within the color specified",
"example": "Af",
"type": "line"
},
"textcolor": {
"label": "Text color",
"description": "CSS color of text inside the legend's colored box",
"type": "string"
},
"size": {
"description": "Size of the legend entry",
"type": "string"
}
},
"description": "Shows a legend row with a colored box and a caption."
}
</templatedata>
| 