Template:Legend/doc
Appearance
This is a documentation subpage for Template:Legend. It may contain usage information, categories and other content that is not part of the original template page. |
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. |
This template uses TemplateStyles: |
Shows a legend row with a colored box.
Usage
[edit]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
[edit]Use in text
[edit]{{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
[edit]Markup | Renders as |
---|---|
|
|
Use with all parameters
[edit]{{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
[edit]{{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
[edit]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
[edit]- 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
[edit]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 |