Difference between revisions of "Template:Legend/doc"
Jump to navigation
Jump to search
imported>Daviddwd (Template Data) |
imported>A876 (mention {legend striped}, for two colors. updated use-count. split para into list. reduced contradictory parameter names.) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!----PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE----> | <!----PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE----> | ||
| − | {{High use| | + | {{High-use|17355.142857142857142857142857142857142857142857142857142857142857142857}} |
Shows a legend row with a colored box. | Shows a legend row with a colored box. | ||
__TOC__ | __TOC__ | ||
==Usage== | ==Usage== | ||
| − | <nowiki>{{</nowiki>legend|''color''|'' | + | <nowiki>{{</nowiki>legend|''background-color''|''caption''|outline=''outline color''|border=''css border''<nowiki>}}</nowiki> |
| − | ''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. | + | *''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 ''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. | ||
==Examples== | ==Examples== | ||
| Line 24: | Line 26: | ||
{{legend|#ff2800|Asia}} | {{legend|#ff2800|Asia}} | ||
| − | ===Use in | + | ===Use in captions=== |
{{markup|<nowiki> | {{markup|<nowiki> | ||
| − | [[ | + | [[File:Celts in Europe.png|200px|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 | + | {{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|#97ffb6|Other parts of Europe once peopled by Celts; modern-day inhabitants of many of these areas often claim a Celtic heritage and/or culture}} | |
| − | {{legend|#97ffb6|Other parts of Europe once peopled by Celts; modern-day inhabitants of many of | + | {{legend|#D2FFD2|Lusitanian area of Iberia, "Celticity" uncertain}} |
| − | |||
| − | {{legend|#D2FFD2|Lusitanian area of Iberia, "Celticity" uncertain}} | ||
{{legend|yellow|The core Hallstatt territory, expansion before 500 BC}} | {{legend|yellow|The core Hallstatt territory, expansion before 500 BC}} | ||
]] | ]] | ||
</nowiki>| | </nowiki>| | ||
| − | [[ | + | [[File:Celts in Europe.png|200px|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 | + | {{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|#97ffb6|Other parts of Europe once peopled by Celts; modern-day inhabitants of many of these areas often claim a Celtic heritage and/or culture}} | {{legend|#97ffb6|Other parts of Europe once peopled by Celts; modern-day inhabitants of many of these areas often claim a Celtic heritage and/or culture}} | ||
{{legend|#D2FFD2|Lusitanian area of Iberia, "Celticity" uncertain}} | {{legend|#D2FFD2|Lusitanian area of Iberia, "Celticity" uncertain}} | ||
| Line 44: | Line 44: | ||
}} | }} | ||
| − | == Full parameter list == | + | ==Full parameter list== |
<pre> | <pre> | ||
| − | {{ | + | {{legend |
| − | | [legend box's colo | + | | [legend box's colo(u)r] |
| [text following legend box] | | [text following legend box] | ||
| − | | outline = <!--colo | + | | outline = <!--colo(u)r of border around legend box--> |
| border = <!--use to specify custom CSS styling for border (overrides 'outline')--> | | border = <!--use to specify custom CSS styling for border (overrides 'outline')--> | ||
| − | | color = <!--colo | + | | color = <!--colo(u)r of 'text'--> |
| size = <!--'text' font-size--> | | size = <!--'text' font-size--> | ||
| text = <!--to place text inside the legend box--> | | text = <!--to place text inside the legend box--> | ||
| Line 57: | Line 57: | ||
</pre> | </pre> | ||
| − | == See also == | + | ==See also== |
| − | * Variants | + | *Variants |
| − | ** {{tl| | + | **{{tl|legend inline}}, uses ''display:inline'' to avoid line breaks after each legend |
| − | ** {{tl| | + | **{{tl|legend0}}, without the line-feed |
| − | ** {{tl| | + | **{{tl|legend2}}, without block formatting |
| − | ** {{tl| | + | **{{tl|legend4}}, with indented block formatting |
| − | ** {{tl| | + | **{{tl|leftlegend}}, with text-align set to left |
| − | ** {{tl|Color box}} or {{tl|RouteBox}}, with text placed inside the colored legend and article linking | + | **{{tl|legend striped}}, two colors, for striped color areas |
| − | + | *{{tl|legend-line}}, legends for lines | |
| − | * [[Web colors]] | + | **{{tl|Color box}} or {{tl|RouteBox}}, with text placed inside the colored legend and article linking |
| + | *[[Web colors]] | ||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | ||
| Line 72: | Line 73: | ||
[[Category:Legend templates]] | [[Category:Legend templates]] | ||
}}</includeonly> | }}</includeonly> | ||
| − | == TemplateData == | + | |
| − | {{ | + | ==TemplateData== |
| + | {{TemplateData header}} | ||
<templatedata> | <templatedata> | ||
{ | { | ||
Revision as of 23:16, 9 March 2019
| 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). |
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.
Examples
Use in text
{{legend|black|Africa}}
{{legend|green|Americas}}
{{legend|blue|Oceania}}
{{legend|#ffa|Europe|outline=silver}}
{{legend|#ff2800|Asia}}
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
- 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
- {{legend striped}}, two colors, for striped color areas
- {{legend-line}}, legends for lines
- 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 | Size of the legend entry | String | optional |
