Tempulet:Legend/doc
Tempulet:Documentation subpage Tempulet:High-use Tempulet:Uses TemplateStyles Shows a legend row with a colored box.
Usage
nen̄e ge{{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
nen̄e geUse in text
nen̄e ge{{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.)
Use in captions
nen̄e geFull parameter list
nen̄e ge{{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
nen̄e geUsing certain special characters in Tempulet:Para that have meaning in wikitext can cause unexpected results. To use Tempulet:Asterisk in Tempulet:Para, use Tempulet:Para. To use # in Tempulet:Para, use Tempulet:Para.
See also
nen̄e ge- Variant blocks
- Tempulet:Tl, two colors, for striped color areas
- Tempulet:Tl, uses display:inline to avoid line breaks after each legend
- Tempulet:Tl, without the line-feed
- Tempulet:Tl, with text-align set to left
- Tempulet:Tl and Tempulet:Tl, with text placed inside the colored legend and article linking
- Tempulet:Tl, legends for lines
- Tempulet:Tl, allows legend templates being used in image captions to use multiple columns
Templates that list colors
TemplateData
nen̄e geShows 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 |