Template:Legend: Difference between revisions
m (1 revision imported from wikipedia:Template:Legend) |
m (1 revision imported) |
||
| Line 1: | Line 1: | ||
<includeonly><!-- | |||
--><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|}}} | |||
| <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> | |||
Revision as of 14:59, 4 November 2024
File:Test Template Info-Icon - Version (2).svg Template documentation[view] [edit] [history] [purge]
.svg){kind=link}
| File:Ambox warning yellow.svg | This template is used on approximately 36,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. |
| File:Farm-Fresh css add.svg | This template uses TemplateStyles: |
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: <div class="legend"><span class="legend-color mw-no-invert" style="background-color:#1a8000; color:white;"> </span> Present-day Celtic-speaking areas</div> <div class="legend"><span class="legend-color mw-no-invert" style="background-color:#27c600; color:black;"> </span> Other parts of the six most commonly recognized "Celtic nations" and where a Celtic language is spoken but not the dominating language</div> <div class="legend"><span class="legend-color mw-no-invert" style="background-color:#97ffb6; color:black;"> </span> Other parts of Europe once peopled by Celts; modern-day inhabitants of many of these areas often claim a Celtic heritage and/or culture</div> <div class="legend"><span class="legend-color mw-no-invert" style="background-color:#D2FFD2; color:black;"> </span> Lusitanian area of Iberia, "Celticity" uncertain</div> <div class="legend"><span class="legend-color mw-no-invert" style="background-color:yellow; color:black;"> </span> The core Hallstatt territory, expansion before 500 BC</div>]] |
|
Use with all parameters
<syntaxhighlight lang="wikitext">
green The meadow is green.
</syntaxhighlight>
green The meadow is green.
Full parameter list
<syntaxhighlight lang="wikitext">
[text following legend box]
</syntaxhighlight>
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 |