Template:Legend/doc: Difference between revisions

m
81 revisions imported from wikipedia:Template:Legend/doc
(Template Data)
m (81 revisions imported from wikipedia:Template:Legend/doc)
 
(13 intermediate revisions by 10 users not shown)
Line 1:
{{Documentation subpage}}
<!----PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE---->
{{High-use|17355.142857142857142857142857142857142857142857142857142857142857142857}}
{{High use| 2151 }}
{{Uses TemplateStyles|Template:Legend/styles.css}}
Shows a legend row with a colored box.
__TOC__
 
==Usage==
<nowiki>{{</nowiki>legend|''background-color''|''labelcaption''|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. If you need to customize the border further, you can use the ''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.
*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 16 ⟶ 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 22 ⟶ 25:
{{legend|blue|Oceania}}
{{legend|#ffa|Europe|outline=silver}}
{{legend|#ff2800|Asia|outline=#A2A9B1}}
 
===Use in a caption captions===
{{markup|<nowiki>
[[ImageFile:Celts in Europe.png|200pxupright=.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}}
Celtic language is spoken but not the dominating language}}
{{legend|#D2FFD2|Lusitanian area of Iberia, "Celticity" uncertain}}
{{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>|
[[ImageFile:Celts in Europe.png|200pxupright=.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}}
Line 44 ⟶ 45:
}}
 
== Full parameter list ==
<pre>
{{Legendlegend
| [legend box's colo/ur(u)r]
| [text following legend box]
| outline = <!--colo/ur(u)r of border around legend box-->
| border = <!--use to specify custom CSS styling for border (overrides 'outline')-->
| color = <!--colo/ur(u)r of 'text'-->
| size = <!--'text' font-size-->
| text = <!--to place text inside the legend box-->
Line 57 ⟶ 58:
</pre>
 
== See also ==
*Variant blocks
* Variants
**{{tl|legend striped}}, two colors, for striped color areas
** {{tl|Legendlegend inline}}, uses ''display:inline'' to avoid line breaks after each legend.
** {{tl|Legend0}}, without the line-feed.
** {{tl|Legend2legend0}}, without blockthe formatting.line-feed
** {{tl|Legend4legend2}}, with indentedwithout block formatting.
** {{tl|Leftlegendlegend4}}, with text-align setindented toblock left.formatting
** {{tl|Color box}} or {{tl|RouteBoxleftlegend}}, with text-align placed inside the colored legend andset articleto linking.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]]
*{{tl|legend-col}}, allows legend templates being used in image captions to use multiple columns
 
*[[Web colors]]<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
{{Sandbox other|
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:Legend templates]]
}}</includeonly>
 
== TemplateData ==
{{TemplateDataHeader}}
{{TemplateData header}}
<templatedata>
{
Line 114 ⟶ 117:
},
"size": {
"description": "SizeFont size of the legend entry, including colored box",
"type": "string"
}