Template:Legend: Difference between revisions
From Roses, Tulips, & Liberty
Content added Content deleted
(change to square) |
m (99 revisions imported from wikipedia:Template:Legend) |
||
| (32 intermediate revisions by 20 users not shown) | |||
| Line 1: | Line 1: | ||
<includeonly><!-- |
|||
<includeonly><span style="margin:0px; font-size:90%; display:block;"><span style="border:{{{border|none}}}; background-color:{{{1|none}}}; color:{{{1|none}}};"> </span> {{{2|}}}</span></includeonly><noinclude> |
|||
--><templatestyles src="Legend/styles.css" /><!-- |
|||
--><div class="legend"><!-- |
|||
--><span class="legend-color mw-no-invert" style="<!-- |
|||
-->{{#if:{{{border|}}}|border: {{{border}}};|{{#if:{{{outline|}}}|border: 1px solid {{{outline}}};}}}}<!-- |
|||
-->{{#if:{{{1|}}}|{{greater color contrast ratio|{{{1}}}|white|black|css=y}}}}<!-- |
|||
-->{{#if:{{{textcolor|}}}|color:{{{textcolor}}};}}<!-- |
|||
-->{{#if:{{{size|}}}|font-size:{{{size}}};}}"><!-- |
|||
-->{{#if:{{{text|}}}{{{alt|}}} |
|||
{{Legend/doc}} |
|||
| <span class="legend-text" style="{{#if:{{{alt|}}}|color:{{{1|}}};}}font-family: monospace, monospace;">{{If empty|{{{alt|}}}|{{{text|}}}| }}</span>| }}<!-- |
|||
--></span><!-- |
|||
--> {{{2|}}}<!-- |
|||
--></div><!-- |
|||
--></includeonly><noinclude> |
|||
{{Documentation}} |
|||
</noinclude> |
</noinclude> |
||
Latest revision as of 18:58, 17 February 2024
 | This template is used on approximately 33,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
Lua error in Module:TNT at line 159: Missing JsonConfig extension; Cannot load https://commons.wikimedia.org/wiki/Data:I18n/Uses TemplateStyles.tab. Shows a legend row with a colored box.
Usage
 | This section is missing information about the function of the parameter alt. (December 2023) |
{{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}}
]]
|
 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 |
Use with all parameters
{{legend
| #ded <!--light green-->
| The meadow is green.
| outline = #00e <!--blue >> will be not used because overridden by border-parameter-->
| border = 2px solid #e00 <!--red-->
| textcolor = #00e <!--blue-->
| size = 200%
| text = green
}}
green The meadow is green.
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')-->
| textcolor = <!--colo(u)r of 'text'-->
| size = <!--'text' font-size-->
| text = <!--to place text inside the legend box-->
}}
Limitations
Using certain special characters in |text= that have meaning in wikitext can cause unexpected results. To use * in |text=, use |text={{asterisk}}. To use # in |text=, use |text={{number sign}}.
See also
- Variant blocks
- {{legend striped}}, two colors, for striped color areas
- {{legend inline}}, uses display:inline to avoid line breaks after each legend
- {{legend0}}, without the line-feed
- {{leftlegend}}, with text-align set to left
- {{color box}} and {{RouteBox}}, with text placed inside the colored legend and article linking
- {{legend-line}}, legends for lines
- {{image key}}, allows legend templates being used in image captions to use multiple columns
Templates that list colors
- {{Colornames}}
- {{X11 color chart}}
- {{Web Colors}}
TemplateData
| This section is missing information about the function of the parameter alt. (December 2023) |
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Legend in articles based on its TemplateData.
TemplateData for Legend
Shows a legend row with a colored box and a caption.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Color | 1 | The color for the legend entry, in any CSS format
| Line | required |
| Caption | 2 | Label for the legend entry
| String | suggested |
| CSS border style | border | CSS style for the legend entry's border | String | optional |
| Entry outline | outline | CSS color for the outline of the legend entry
| Line | optional |
| Text in the entry | text | Text to be displayed in the legend entry box, i.e. within the color specified
| Line | optional |
| Text color | textcolor | CSS color of text inside the legend's colored box | String | optional |
| Size | size | Font size of the legend entry, including colored box | String | optional |
