3,060
edits
(→See also: how about a link to web colors) |
Metriximor (talk | contribs) m (81 revisions imported from wikipedia:Template:Legend/doc) |
||
(34 intermediate revisions by 22 users not shown) | |||
Line 1:
{{Documentation subpage}}
<!--
{{High-use|17355.142857142857142857142857142857142857142857142857142857142857142857}}
{{Uses TemplateStyles|Template:Legend/styles.css}}
Shows a legend row with a colored box.
__TOC__
==Usage==
<nowiki>{{</nowiki>legend|''background-color''|''
*''background-color'' is passed to the [[Cascading Style Sheets|css]] background-color property of the color
*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==
Line 15 ⟶ 19:
<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}}
Line 21 ⟶ 25:
{{legend|blue|Oceania}}
{{legend|#ffa|Europe|outline=silver}}
{{legend|#ff2800|Asia|outline=#A2A9B1}}
===Use in
[[
{{legend|#1a8000|
{{legend|#27c600|
{{legend|#97ffb6|
{{legend|#D2FFD2|Lusitanian area of Iberia, "Celticity" uncertain}}
▲ {{legend|#97ffb6|other parts of Europe once peopled by Celts; modern-day inhabitants of many of
▲ {{legend|yellow|the core Hallstatt territory, expansion before 500 BC}}
]]
</nowiki>
[[
{{legend|#1a8000|
{{legend|#27c600|
{{legend|#97ffb6|
{{legend|
{{legend|yellow|The core Hallstatt territory, expansion before 500 BC}}]]
}}
==Full parameter list==
<pre>
{{legend
| [legend box's colo(u)r]
| outline = <!--colo(u)r of border
| border = <!--use
| color = <!--
| size = <!--'text' font
| text = <!--to place text inside the
}}
</pre>
==See also==
*Variant blocks
* For a version of this template using ''display:inline'' to avoid line breaks after each legend, see {{tl|Legend inline}}.▼
**{{tl|legend striped}}, two colors, for striped color areas
▲**{{tl|legend
**{{tl|legend0}}, without the line-feed
* [[Web colors]]▼
**{{tl|legend2}}, without block formatting
<includeonly>▼
**{{tl|legend4}}, with indented block formatting
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->▼
**{{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
*{{tl|legend-col}}, allows legend templates being used in image captions to use multiple columns
{{Sandbox other|
[[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": "Font size of the legend entry, including colored box",
"type": "string"
}
},
"description": "Shows a legend row with a colored box and a caption."
}
</templatedata>
|