Template:Wp/ann/Legend
Template:Wp/ann/Documentation subpage Template:Wp/ann/High-use Template:Wp/ann/Uses TemplateStyles Shows a legend row with a colored box.
Usage edit
{{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
{{Wp/ann/legend|black|Africa}}
{{Wp/ann/legend|green|Americas}}
{{Wp/ann/legend|blue|Oceania}}
{{Wp/ann/legend|#ffa|Europe|outline=silver}}
{{Wp/ann/legend|#ff2800|Asia|outline=#A2A9B1}} (#A2A9B1 is the wikitables border color.)
Template:Wp/ann/legend Template:Wp/ann/legend Template:Wp/ann/legend Template:Wp/ann/legend Template:Wp/ann/legend
edit
Full parameter list edit
{{Wp/ann/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--> }}
Limitations edit
Using certain special characters in Template:Wp/ann/para that have meaning in wikitext can cause unexpected results. To use Template:Wp/ann/asterisk in Template:Wp/ann/para, use Template:Wp/ann/para. To use # in Template:Wp/ann/para, use Template:Wp/ann/para.
See also edit
- Variant blocks
- Template:Wp/ann/tl, two colors, for striped color areas
- Template:Wp/ann/tl, uses display:inline to avoid line breaks after each legend
- Template:Wp/ann/tl, without the line-feed
- Template:Wp/ann/tl, with text-align set to left
- Template:Wp/ann/tl and Template:Wp/ann/tl, with text placed inside the colored legend and article linking
- Template:Wp/ann/tl, legends for lines
- Template:Wp/ann/tl, allows legend templates being used in image captions to use multiple columns
Templates that list colors
TemplateData edit
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 |