Template:Legend/doc: Difference between revisions

m
81 revisions imported from wikipedia:Template:Legend/doc
m (81 revisions imported from wikipedia:Template:Legend/doc)
 
(42 intermediate revisions by 27 users not shown)
Line 1:
{{Documentation subpage}}
<!-- --PLEASE ADD CATEGORIES ANDWHERE INTERWIKISINDICATED AT THE BOTTOM OF THIS PAGE ---->
{{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''|''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 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 a caption captions===
<pre>{{markup|<nowiki>
[[ImageFile:Celts in Europe.png|200pxupright=.9|thumb|right|The Celts in Europe, past and present:
{{legend|#1a8000|presentPresent-day Celtic-speaking areas}}
{{legend|#27c600|otherOther 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
{{legend|yellow|The core Hallstatt territory, expansion before 500 BC}}
these areas often claim a Celtic heritage and/or culture}}
]]
</nowiki></pre>|
[[ImageFile:Celts in Europe.png|200pxupright=.9|thumb|right|The Celts in Europe, past and present:
{{legend|#1a8000|presentPresent-day Celtic-speaking areas}}
{{legend|#27c600|otherOther parts of the six most commonly recognized '"Celtic nations'" and where a Celtic language is spoken but not the dominating language}}
{{legend|#97ffb6|otherOther 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
* 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
* For a version of this template without block formatting, see {{tl|Legend2}}.
**{{tl|legend inline}}, uses ''display:inline'' to avoid line breaks after each legend
* For legend rows representing lines, see {{tl|legend-line}}.
**{{tl|legend0}}, without the line-feed
<includeonly>
**{{tl|legend2}}, without block formatting
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
**{{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
*{{tl|legend-col}}, allows legend templates being used in image captions to use multiple columns
*[[Web colors]]<includeonly>
{{Sandbox other|
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:Legend templates]]
}}</includeonly>
 
==TemplateData==
[[ar:قالب:مفتاح خريطة]]
{{TemplateData header}}
[[af:Sjabloon:Legend]]
<templatedata>
[[bg:Шаблон:Легенда]]
{
[[ca:Template:Llegenda]]
"params": {
[[cs:Šablona:Legenda]]
"1": {
[[cy:Nodyn:Legend]]
"label": "Color",
[[da:Skabelon:Legend]]
"description": "The color for the legend entry, in any CSS format",
[[de:Vorlage:Farblegende]]
"example": "\"#6D6E00\", \"#ffa\", \"yellow\"",
[[dsb:Pśedłoga:Legenda]]
"type": "line",
[[eo:Ŝablono:Priskribo]]
"required": true
[[es:Plantilla:Leyenda]]
},
[[et:Mall:Legend]]
"2": {
[[fr:Modèle:Légende]]
"label": "Caption",
[[he:תבנית:מקרא]]
"description": "Label for the legend entry",
[[hi:Template:Legend]]
"example": "\"soda\" is most common",
[[hsb:Předłoha:Legenda]]
"type": "string",
[[id:Templat:Legend]]
"suggested": true
[[ia:Patrono:Legend]]
},
[[is:Snið:Skýringartexti]]
"border": {
[[it:Template:Legenda]]
"label": "CSS border style",
[[ja:Template:Legend]]
"description": "CSS style for the legend entry's border",
[[ka:თარგი:ლეგენდა]]
"type": "string"
[[ko:Template:범례]]
},
[[ku:Şablon:Legend]]
"outline": {
[[hu:Sablon:Jelmagyarázat]]
"label": "Entry outline",
[[mk:Шаблон:Легенда]]
"description": "CSS color for the outline of the legend entry",
[[nl:Sjabloon:Legenda]]
"example": "silver",
[[nn:Mal:Legend]]
"type": "line"
[[no:Mal:Legend]]
},
[[os:Шаблон:Легендæ]]
"text": {
[[pl:Szablon:Legenda]]
"label": "Text in the entry",
[[pt:Predefinição:Legenda]]
"description": "Text to be displayed in the legend entry box, i.e. within the color specified",
[[rmy:Sikavno:Xalyaripen]]
"example": "Af",
[[ro:Format:Legendă]]
"type": "line"
[[ru:Шаблон:Легенда]]
},
[[sk:Šablóna:Legenda]]
"textcolor": {
[[sl:Predloga:Legenda]]
"label": "Text color",
[[cu:Обраꙁь́ць:Legend]]
"description": "CSS color of text inside the legend's colored box",
[[sr:Шаблон:Легенда]]
"type": "string"
[[fi:Malline:Seloste]]
},
[[sv:Mall:Legend]]
"size": {
[[szl:Szablon:Legynda]]
"description": "Font size of the legend entry, including colored box",
[[tpi:Template:Legend]]
"type": "string"
[[tr:Şablon:Legend]]
}
[[vep:Šablon:Legend]]
},
[[vi:Tiêu bản:Legend]]
"description": "Shows a legend row with a colored box and a caption."
[[uk:Шаблон:Legend]]
}
[[zh:Template:Legend]]
</templatedata>
[[zu:Template:Legend]]
</includeonly>