Template:Legend/doc
Jump to navigation
Jump to search
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 29,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
{{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
Christian Coalition: 6 seats
American Republican Party: 28 seats
Conscience Republicans: 8 seats
Libertarian Party: 6 seats
New Whig Party: 22 seats
Blue Dog Party: 5 seats
Stalwart Democratic Party: 14 seats
Justice Democrats: 19 seats
Socialist Alliance: 10 seats
Rockefeller Party: 1 seat
Use in captions
Markup | Renders as |
---|---|
[markup] |
[rendering] |
[markup] |
[rendering] |
[markup] |
[rendering] |
[markup] |
[rendering] |
[markup] |
[rendering] |
[markup] |
[rendering] |
[markup] |
[rendering] |
[markup] |
[rendering] |
[markup] |
[rendering] |
[markup] |
[rendering] |
[markup] |
[rendering] |
[markup] |
[rendering] |
[markup] |
[rendering] |
[markup] |
[rendering] |
[markup] |
[rendering] |
[markup] |
[rendering] |
[markup] |
[rendering] |
[markup] |
[rendering] |
[markup] |
[rendering] |
[markup] |
[rendering] |
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
- 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
- {{legend2}}, without block formatting
- {{legend4}}, with indented block formatting
- {{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
- Web colors
TemplateData
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this 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 |