Template:Legend/doc: Difference between revisions
Jump to navigation
Jump to search
Content added Content deleted
(update /doc) |
Metriximor (talk | contribs) m (81 revisions imported from wikipedia:Template:Legend/doc) |
||
(15 intermediate revisions by 12 users not shown) | |||
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|17355.142857142857142857142857142857142857142857142857142857142857142857}} |
|||
{{High use| 20027 }} |
|||
{{Uses TemplateStyles|Template:Legend/styles.css}} |
|||
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 |
*''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 16: | 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 22: | 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 |
===Use in captions=== |
||
{{markup|<nowiki> |
{{markup|<nowiki> |
||
[[ |
[[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 |
{{legend|#27c600|Other parts of the six most commonly recognized "Celtic nations" and where a Celtic language is spoken but not the dominating language}} |
||
⚫ | |||
Celtic language is spoken but not the dominating language}} |
|||
⚫ | |||
⚫ | |||
these areas often claim a Celtic heritage and/or culture}} |
|||
⚫ | |||
{{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|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 |
{{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 45: | ||
}} |
}} |
||
== |
==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 58: | ||
</pre> |
</pre> |
||
== |
==See also== |
||
*Variant blocks |
|||
* Variants |
|||
**{{tl|legend striped}}, two colors, for striped color areas |
|||
** |
**{{tl|legend inline}}, uses ''display:inline'' to avoid line breaks after each legend |
||
** {{tl|Legend0}}, without the line-feed. |
|||
** |
**{{tl|legend0}}, without the line-feed |
||
** |
**{{tl|legend2}}, without block formatting |
||
** |
**{{tl|legend4}}, with indented block formatting |
||
** |
**{{tl|leftlegend}}, with text-align set to left |
||
**{{tl|color box}} and {{tl|RouteBox}}, with text placed inside the colored legend and article linking |
|||
* |
*{{tl|legend-line}}, legends for lines |
||
* [[Web colors]] |
|||
*{{tl|legend-col}}, allows legend templates being used in image captions to use multiple columns |
|||
<includeonly> |
*[[Web colors]]<includeonly> |
||
{{Sandbox other| |
|||
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: --> |
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: --> |
||
[[Category:Legend templates]] |
[[Category:Legend templates]] |
||
}}</includeonly> |
}}</includeonly> |
||
==TemplateData== |
|||
{{TemplateData header}} |
|||
<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": "Font size of the legend entry, including colored box", |
|||
"type": "string" |
|||
} |
|||
}, |
|||
"description": "Shows a legend row with a colored box and a caption." |
|||
} |
|||
</templatedata> |
Latest revision as of 23:29, 19 May 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 23,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
Markup | Renders as |
---|---|
[[File:Celts in Europe.png|upright=.9|thumb|right|The Celts in Europe, past and present: {{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|#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|yellow|The core Hallstatt territory, expansion before 500 BC}} ]] |
|
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 |