మూస:Legend/doc
స్వరూపం
This is a documentation subpage for మూస:Legend. It may contain usage information, categories and other content that is not part of the original మూస page. |
This template is used on approximately 31,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 |
---|---|
[[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}} ]] |
|
Use with all parameters
[మార్చు]{{legend | #ded <!--light green--> | The meadow is green. | outline = #00e <!--blue >> will be not used because overridden by border-parameter--> | border = 2px solid #e00 <!--red--> | textcolor = #00e <!--blue--> | size = 200% | text = green }}
green The meadow is green.
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')--> | textcolor = <!--colo(u)r of 'text'--> | size = <!--'text' font-size--> | text = <!--to place text inside the legend box--> }}
Limitations
[మార్చు]Using certain special characters in |text=
that have meaning in wikitext can cause unexpected results. To use * in |text=
, use |text={{asterisk}}
. To use # in |text=
, use |text={{number sign}}
.
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
- {{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
- {{image key}}, allows legend templates being used in image captions to use multiple columns
Templates that list colors
- {{Colornames}}
- {{X11 color chart}}
- {{Web Colors}}
TemplateData
[మార్చు]This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Legend in articles based on its TemplateData.
TemplateData for Legend
Shows a legend row with a colored box and a caption.
పరామితి | వివరణ | రకం | స్థితి | |
---|---|---|---|---|
Color | 1 | The color for the legend entry, in any CSS format
| లైను | తప్పనిసరి |
Caption | 2 | Label for the legend entry
| స్ట్రింగు | సూచించినవి |
CSS border style | border | CSS style for the legend entry's border | స్ట్రింగు | ఐచ్చికం |
Entry outline | outline | CSS color for the outline of the legend entry
| లైను | ఐచ్చికం |
Text in the entry | text | Text to be displayed in the legend entry box, i.e. within the color specified
| లైను | ఐచ్చికం |
Text color | textcolor | CSS color of text inside the legend's colored box | స్ట్రింగు | ఐచ్చికం |
Size | size | Font size of the legend entry, including colored box | స్ట్రింగు | ఐచ్చికం |