Template:Legend/doc: Difference between revisions
m update /doc |
Template Data |
||
Line 72: | Line 72: | ||
[[Category:Legend templates]] |
[[Category:Legend templates]] |
||
}}</includeonly> |
}}</includeonly> |
||
== TemplateData == |
|||
{{TemplateDataHeader}} |
|||
<templatedata> |
|||
{ |
|||
"params": { |
|||
"1": { |
|||
"label": "Color", |
|||
"description": "The color for the legend entry, in any CSS format", |
|||
"example": "\"#6D6E00\", \"#ffa\", \"yellow\"", |
|||
"type": "line", |
|||
"required": true |
|||
}, |
|||
"2": { |
|||
"label": "Caption", |
|||
"description": "Label for the legend entry", |
|||
"example": "\"soda\" is most common", |
|||
"type": "string", |
|||
"suggested": true |
|||
}, |
|||
"border": { |
|||
"label": "CSS border style", |
|||
"description": "CSS style for the legend entry's border", |
|||
"type": "string" |
|||
}, |
|||
"outline": { |
|||
"label": "Entry outline", |
|||
"description": "CSS color for the outline of the legend entry", |
|||
"example": "silver", |
|||
"type": "line" |
|||
}, |
|||
"text": { |
|||
"label": "Text in the entry", |
|||
"description": "Text to be displayed in the legend entry box, i.e. within the color specified", |
|||
"example": "Af", |
|||
"type": "line" |
|||
}, |
|||
"textcolor": { |
|||
"label": "Text color", |
|||
"description": "CSS color of text inside the legend's colored box", |
|||
"type": "string" |
|||
}, |
|||
"size": { |
|||
"description": "Size of the legend entry", |
|||
"type": "string" |
|||
} |
|||
}, |
|||
"description": "Shows a legend row with a colored box and a caption." |
|||
} |
|||
</templatedata> |
Revision as of 23:46, 19 January 2019
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. |
Shows a legend row with a colored box.
Usage
{{legend|color|label|outline=outline color|border=css border}}
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. If you need to customize the border further, you can use the 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}}
Use in a caption
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/ur] | [text following legend box] | outline = <!--colo/ur of border around legend box--> | border = <!--use to specify custom CSS styling for border (overrides 'outline')--> | color = <!--colo/ur of 'text'--> | size = <!--'text' font-size--> | text = <!--to place text inside the legend box--> }}
See also
- Variants
- {{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}} or {{RouteBox}}, with text placed inside the colored legend and article linking.
- {{legend-line}}, legends for lines.
- Web colors
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 | Size of the legend entry | String | optional |