Template:Legend/doc: Difference between revisions

← Older edit

Template:Legend/doc (view source)

Revision as of 23:29, 19 May 2021

1,582 bytes added , 3 years ago

m

81 revisions imported from wikipedia:Template:Legend/doc

VisualWikitext

Metriximor

Autopatrolled users, Bureaucrats, Confirmed users, Rollbackers, Administrators

3,060

edits

Revision as of 17:10, 29 July 2016 (view source) wikipedia>Hohum (→‎Usage) ← Older edit		Latest revision as of 23:29, 19 May 2021 (view source) Metriximor (talk \| contribs) m (81 revisions imported from wikipedia:Template:Legend/doc)
(19 intermediate revisions by 13 users not shown)
Line 1: {{Documentation subpage}} <!----PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE----> {{High-use\|17355.142857142857142857142857142857142857142857142857142857142857142857}} {{Uses TemplateStyles\|Template:Legend/styles.css}} Shows a legend row with a colored box. __TOC__ ==Usage== <nowiki>{{</nowiki>legend ~~inline~~\|''background-color''\|''~~label~~caption''\|outline=''outline color''\|border=''css border''<nowiki>}}</nowiki> ''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. 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., <code>1px solid #aaa</code>) of the border that will be drawn 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. ==Examples== Line 15 ⟶ 19: <nowiki>{{legend\|blue\|Oceania}}</nowiki> <nowiki>{{legend\|#ffa\|Europe\|outline=silver}}</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}} Line 21 ⟶ 25: {{legend\|blue\|Oceania}} {{legend\|#ffa\|Europe\|outline=silver}} {{legend\|#ff2800\|Asia\|outline=#A2A9B1}} ===Use in ~~a caption~~ captions=== {{markup\|<nowiki> [[~~Image~~File:Celts in Europe.png\|~~200px~~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}}▼ ~~Celtic language is spoken but not the dominating language}}~~ {{legend\|#D2FFD2\|Lusitanian area of Iberia, "Celticity" uncertain}} ▼ ▲ {{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}} ]] </nowiki>\| [[~~Image~~File:Celts in Europe.png\|~~200px~~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}} Line 43 ⟶ 45: }} == Full parameter list == <pre> {{~~Legend~~legend \| [legend box's colo~~/ur~~(u)r] \| [text following legend box] \| outline = <!--colo~~/ur~~(u)r of border around legend box--> \| border = <!--use to specify custom CSS styling for border (overrides 'outline')--> \| color = <!--colo~~/ur~~(u)r of 'text'--> \| size = <!--'text' font-size--> \| text = <!--to place text inside the legend box--> Line 56 ⟶ 58: </pre> == See also == Variant blocks * Variants {{tl\|legend striped}}, two colors, for striped color areas {{tl\|~~Legend~~legend inline}}, uses ''display:inline'' to avoid line breaks after each legend. {{tl\|Legend0}}, without the line-feed. {{tl\|~~Legend2~~legend0}}, without ~~block~~the ~~formatting.~~line-feed {{tl\|~~Legend4~~legend2}}, ~~with indented~~without block formatting. {{tl\|~~Leftlegend~~legend4}}, with ~~text-align set~~indented toblock ~~left.~~formatting {{tl\|~~Color box~~leftlegend}}, with text-align ~~placed inside the~~set ~~colored~~to ~~legend.~~left {{tl\|~~Colorbox~~color box}} orand {{tl\|RouteBox}}, with text placed inside the colored legend and article linking. * {{tl\|legend-line}}, legends for lines. {{tl\|legend-col}}, allows legend templates being used in image captions to use multiple columns [[Web colors]]<includeonly> {{Sandbox other\| ~~<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox \|~~ \| <!-- CATEGORIES BELOW THIS LINE, PLEASE: --> [[Category:Legend templates]] }}</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>