Template:Legend/doc: Difference between revisions
Jump to navigation
Jump to search
Content deleted Content added
m Undid revision 1008229106 by 50.26.129.42 (talk) rvv |
m update /doc |
||
Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> |
|||
<!----PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE----> |
|||
{{High-use|17355.142857142857142857142857142857142857142857142857142857142857142857}} |
{{High-use|17355.142857142857142857142857142857142857142857142857142857142857142857}} |
||
{{Uses TemplateStyles|Template:Legend/styles.css}} |
{{Uses TemplateStyles|Template:Legend/styles.css}} |
||
Line 69: | Line 69: | ||
*{{tl|legend-line}}, legends for lines |
*{{tl|legend-line}}, legends for lines |
||
*{{tl|legend-col}}, allows legend templates being used in image captions to use multiple columns |
*{{tl|legend-col}}, allows legend templates being used in image captions to use multiple columns |
||
*[[Web colors]] |
*[[Web colors]] |
||
⚫ | |||
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: --> |
|||
⚫ | |||
⚫ | |||
==TemplateData== |
==TemplateData== |
||
Line 124: | Line 120: | ||
} |
} |
||
</templatedata> |
</templatedata> |
||
⚫ | |||
<!-- Categories below this line, please; interwikis at Wikidata --> |
|||
⚫ | |||
⚫ |
Revision as of 21:06, 21 July 2021
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
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 |
---|---|
[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
- {{legend-col}}, allows legend templates being used in image captions to use multiple columns
- 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 |