Template:Legend/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>Iketsi
Ookami (talk | contribs)
m 76 revisions imported
 
(38 intermediate revisions by 24 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
<!----PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE---->
{{High-use|17355.142857142857142857142857142857142857142857142857142857142857142857}}
{{Uses TemplateStyles|Template:Legend/styles.css}}
Shows a legend row with a colored box.
Shows a legend row with a colored box.
__TOC__
__TOC__


==Usage==
==Usage==
  <nowiki>{{</nowiki>legend|''color''|''label''|outline=''outline color''|border=''css border''<nowiki>}}</nowiki>
  <nowiki>{{</nowiki>legend|''background-color''|''caption''|outline=''outline color''|border=''css border''<nowiki>}}</nowiki>


''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.
*''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==
==Examples==
Line 15: Line 19:
  <nowiki>{{legend|blue|Oceania}}</nowiki>
  <nowiki>{{legend|blue|Oceania}}</nowiki>
  <nowiki>{{legend|#ffa|Europe|outline=silver}}</nowiki>
  <nowiki>{{legend|#ffa|Europe|outline=silver}}</nowiki>
  <nowiki>{{legend|#ff2800|Asia}}</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|black|Africa}}
Line 21: Line 25:
{{legend|blue|Oceania}}
{{legend|blue|Oceania}}
{{legend|#ffa|Europe|outline=silver}}
{{legend|#ffa|Europe|outline=silver}}
{{legend|#ff2800|Asia}}
{{legend|#ff2800|Asia|outline=#A2A9B1}}


===Use in a caption ===
===Use in captions===
<pre><nowiki>
{{markup|<nowiki>
  [[Image:Celts in Europe.png|200px|thumb|right|The Celts in Europe, past and present:
  [[File:Celts in Europe.png|upright=.9|thumb|right|The Celts in Europe, past and present:
  {{legend|#1a8000|present-day Celtic-speaking areas}}
  {{legend|#1a8000|Present-day Celtic-speaking areas}}
  {{legend|#27c600|other parts of the six most commonly recognized 'Celtic nations' and where a  
  {{legend|#27c600|Other parts of the six most commonly recognized "Celtic nations" and where a Celtic language is spoken but not the dominating language}}
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|#97ffb6|other parts of Europe once peopled by Celts; modern-day inhabitants of many of  
{{legend|#D2FFD2|Lusitanian area of Iberia, "Celticity" uncertain}}
these areas often claim a Celtic heritage and/or culture}}
{{legend|yellow|The core Hallstatt territory, expansion before 500 BC}}
  ]]
  ]]
</nowiki></pre>
</nowiki>|
[[Image:Celts in Europe.png|200px|thumb|right|The Celts in Europe, past and present:  
[[File:Celts in Europe.png|upright=.9|thumb|right|The Celts in Europe, past and present:
{{legend|#1a8000|present-day Celtic-speaking areas}}
{{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|#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|#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==
==See also==
* For a version of this template using ''display:inline'' to avoid line breaks after each legend, see {{tl|Legend inline}}.
*Variant blocks
* For a version of this template without block formatting, see {{tl|Legend2}}.
**{{tl|legend striped}}, two colors, for striped color areas
* For legend rows representing lines, see {{tl|legend-line}}.
**{{tl|legend inline}}, uses ''display:inline'' to avoid line breaks after each legend
<includeonly>
**{{tl|legend0}}, without the line-feed
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
**{{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]]
[[Category:Legend templates]]
}}</includeonly>


[[ar:قالب:مفتاح خريطة]]
==TemplateData==
[[af:Sjabloon:Legend]]
{{TemplateData header}}
[[bg:Шаблон:Легенда]]
<templatedata>
[[ca:Template:Llegenda]]
{
[[cs:Šablona:Legenda]]
"params": {
[[cy:Nodyn:Legend]]
"1": {
[[da:Skabelon:Legend]]
"label": "Color",
[[de:Vorlage:Farblegende]]
"description": "The color for the legend entry, in any CSS format",
[[dsb:Pśedłoga:Legenda]]
"example": "\"#6D6E00\", \"#ffa\", \"yellow\"",
[[eo:Ŝablono:Priskribo]]
"type": "line",
[[es:Plantilla:Leyenda]]
"required": true
[[et:Mall:Legend]]
},
[[fr:Modèle:Légende]]
"2": {
[[he:תבנית:מקרא]]
"label": "Caption",
[[hi:Template:Legend]]
"description": "Label for the legend entry",
[[hsb:Předłoha:Legenda]]
"example": "\"soda\" is most common",
[[id:Templat:Legend]]
"type": "string",
[[ia:Patrono:Legend]]
"suggested": true
[[is:Snið:Skýringartexti]]
},
[[it:Template:Legenda]]
"border": {
[[ja:Template:Legend]]
"label": "CSS border style",
[[ka:თარგი:ლეგენდა]]
"description": "CSS style for the legend entry's border",
[[ko:Template:범례]]
"type": "string"
[[ku:Şablon:Legend]]
},
[[hu:Sablon:Jelmagyarázat]]
"outline": {
[[mk:Шаблон:Легенда]]
"label": "Entry outline",
[[nl:Sjabloon:Legenda]]
"description": "CSS color for the outline of the legend entry",
[[nn:Mal:Legend]]
"example": "silver",
[[no:Mal:Legend]]
"type": "line"
[[os:Шаблон:Легендæ]]
},
[[pl:Szablon:Legenda]]
"text": {
[[pt:Predefinição:Legenda]]
"label": "Text in the entry",
[[rmy:Sikavno:Xalyaripen]]
"description": "Text to be displayed in the legend entry box, i.e. within the color specified",
[[ro:Format:Legendă]]
"example": "Af",
[[ru:Шаблон:Легенда]]
"type": "line"
[[sk:Šablóna:Legenda]]
},
[[sl:Predloga:Legenda]]
"textcolor": {
[[cu:Обраꙁь́ць:Legend]]
"label": "Text color",
[[sr:Шаблон:Легенда]]
"description": "CSS color of text inside the legend's colored box",
[[fi:Malline:Seloste]]
"type": "string"
[[sv:Mall:Legend]]
},
[[szl:Szablon:Legynda]]
"size": {
[[tpi:Template:Legend]]
"description": "Font size of the legend entry, including colored box",
[[tr:Şablon:Legend]]
"type": "string"
[[vi:Tiêu bản:Legend]]
}
[[uk:Шаблон:Legend]]
},
[[zh:Template:Legend]]
"description": "Shows a legend row with a colored box and a caption."
[[zu:Template:Legend]]
}
</includeonly>
</templatedata>

Latest revision as of 04:43, 3 September 2020

Lua error in Module:TNT at line 167: Missing Commons dataset I18n/Module:TNT.tab. Shows a legend row with a colored box.

Usage

{{legend|background-color|caption|outline=outline color|border=css border}}
  • 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.
  • The optional border argument which overrides the outline argument and sets the css description (e.g., 1px solid #aaa) of the border that will be drawn around the box.

Examples

Use in text

{{legend|black|Africa}}
{{legend|green|Americas}}
{{legend|blue|Oceania}}
{{legend|#ffa|Europe|outline=silver}}
{{legend|#ff2800|Asia|outline=#A2A9B1}}  (#A2A9B1 is the 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}}
 ]]
File:Celts in Europe.png
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

Full parameter list

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

See also

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Legend

Shows a legend row with a colored box and a caption.

Template parameters

ParameterDescriptionTypeStatus
Color1

The color for the legend entry, in any CSS format

Example
"#6D6E00", "#ffa", "yellow"
Linerequired
Caption2

Label for the legend entry

Example
"soda" is most common
Stringsuggested
CSS border styleborder

CSS style for the legend entry's border

Stringoptional
Entry outlineoutline

CSS color for the outline of the legend entry

Example
silver
Lineoptional
Text in the entrytext

Text to be displayed in the legend entry box, i.e. within the color specified

Example
Af
Lineoptional
Text colortextcolor

CSS color of text inside the legend's colored box

Stringoptional
sizesize

Font size of the legend entry, including colored box

Stringoptional