Difference between revisions of "Template:Legend/doc"
Jump to navigation
Jump to search
imported>A876 (→See also: reordered, checked indents.) |
imported>Mark Bechri (link to {{legend-col}}) |
||
| (9 intermediate revisions by 7 users not shown) | |||
| Line 2: | Line 2: | ||
<!----PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE----> | <!----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}} | ||
Shows a legend row with a colored box. | Shows a legend row with a colored box. | ||
__TOC__ | __TOC__ | ||
| Line 10: | Line 11: | ||
*''background-color'' is passed to the [[Cascading Style Sheets|css]] background-color property of the color box. | *''background-color'' is passed to the [[Cascading Style Sheets|css]] background-color property of the color box. | ||
*The optional ''outline'' parameter is the color of the outline around the 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., <code>1px solid #aaa</code>) of the border that will be drawn around the box. | + | *The optional ''border'' argument which overrides the ''outline'' argument and sets the css description (e.g., <code>1px solid #aaa</code>) of the border that will be drawn around the box. Yes |
==Examples== | ==Examples== | ||
| Line 18: | Line 19: | ||
<nowiki>{{legend|blue|Oceania}}</nowiki> | <nowiki>{{legend|blue|Oceania}}</nowiki> | ||
<nowiki>{{legend|#ffa|Europe|outline=silver}}</nowiki> | <nowiki>{{legend|#ffa|Europe|outline=silver}}</nowiki> | ||
| − | <nowiki>{{legend|#ff2800|Asia}}</nowiki> | + | <nowiki>{{legend|#ff2800|Asia|outline=#A2A9B1}}</nowiki> <small><span style="color:gray">''(#A2A9B1 is the [[Help:Basic table markup|wikitables]] border color.)''</span></small> |
{{legend|black|Africa}} | {{legend|black|Africa}} | ||
| Line 24: | Line 25: | ||
{{legend|blue|Oceania}} | {{legend|blue|Oceania}} | ||
{{legend|#ffa|Europe|outline=silver}} | {{legend|#ffa|Europe|outline=silver}} | ||
| − | {{legend|#ff2800|Asia}} | + | {{legend|#ff2800|Asia|outline=#A2A9B1}} |
===Use in captions=== | ===Use in captions=== | ||
{{markup|<nowiki> | {{markup|<nowiki> | ||
| − | [[File:Celts in Europe.png| | + | [[File:Celts in Europe.png|upright=.9|thumb|right|The Celts in Europe, past and present: |
{{legend|#1a8000|Present-day Celtic-speaking areas}} | {{legend|#1a8000|Present-day Celtic-speaking areas}} | ||
{{legend|#27c600|Other parts of the six most commonly recognized "Celtic nations" and where a Celtic language is spoken but not the dominating language}} | {{legend|#27c600|Other parts of the six most commonly recognized "Celtic nations" and where a Celtic language is spoken but not the dominating language}} | ||
| Line 36: | Line 37: | ||
]] | ]] | ||
</nowiki>| | </nowiki>| | ||
| − | [[File:Celts in Europe.png| | + | [[File:Celts in Europe.png|upright=.9|thumb|right|The Celts in Europe, past and present: |
{{legend|#1a8000|Present-day Celtic-speaking areas}} | {{legend|#1a8000|Present-day Celtic-speaking areas}} | ||
{{legend|#27c600|Other parts of the six most commonly recognized "Celtic nations" and where a Celtic language is spoken but not the dominating language}} | {{legend|#27c600|Other parts of the six most commonly recognized "Celtic nations" and where a Celtic language is spoken but not the dominating language}} | ||
| Line 67: | Line 68: | ||
**{{tl|color box}} and {{tl|RouteBox}}, with text placed inside the colored legend and article linking | **{{tl|color box}} and {{tl|RouteBox}}, with text placed inside the colored legend and article linking | ||
*{{tl|legend-line}}, legends for lines | *{{tl|legend-line}}, legends for lines | ||
| − | *[[Web colors]] | + | *{{tl|legend-col}}, allows legend templates being used in image captions to use multiple columns |
| − | + | *[[Web colors]]<includeonly> | |
| − | <includeonly>{{ | + | {{Sandbox other| |
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: --> | | <!-- CATEGORIES BELOW THIS LINE, PLEASE: --> | ||
[[Category:Legend templates]] | [[Category:Legend templates]] | ||
| Line 116: | Line 117: | ||
}, | }, | ||
"size": { | "size": { | ||
| − | "description": " | + | "description": "Font size of the legend entry, including colored box", |
"type": "string" | "type": "string" | ||
} | } | ||
Latest revision as of 17:19, 12 March 2021
| This is a documentation subpage for Template:Legend. It contains usage information, categories and other content that is not part of the original template page. |
| This template is used on approximately 22,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.
Transclusion count updated automatically (see documentation). |
Script error: No such module "Uses TemplateStyles". Shows a legend row with a colored box.
Contents
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. Yes
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
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 documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.
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 |
