imported>Deadfire: Updating

2023-04-03T00:29:05Z

Updating

New page

{{Documentation subpage}}

{{Uses TemplateStyles|Template:Legend/styles.css}}
Shows a legend row with a colored box.
__TOC__

==Usage==
<nowiki>{{</nowiki>legend|''background-color''|''caption''|outline=''outline color''|border=''css border''<nowiki>}}</nowiki>

*''background-color'' is passed to the [[w: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.

==Full parameter list==
<pre>
{{legend
| [legend box's colo(u)r]
| [text following legend box]
| outline = 
| border = 
| color = 
| size = 
| text = 
}}
</pre>

==Limitations==
Using certain special characters in {{para|text}} that have meaning in wikitext can cause unexpected results. To use {{asterisk}} in {{para|text}}, use {{para|text|{{tlf|asterisk}}}}. To use # in {{para|text}}, use {{para|text|{{tlf|number sign}}}}.

==See also==
===Templates===
*To colour text and background:
** {{tl|Font color}}
** {{tl|background color}}
** {{tl|font}}
*To provide example squares of colour:
** {{tl|Color sample}}
** {{tl|Swatch}}
** {{tl|Swatch inline}}
* To provide a list colors
** {{tl|Colornames}}
** {{tl|Formula Supported Named Colors}}
** {{tl|X11 color chart}}
** {{tl|Web Colors}}

===Wikipedia articles===
* [[w:Color picker|Color picker]]
* [[w:Web colors|Web colors]]
* [[w:HTML color names|HTML color names]]

==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": {
"label": "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>

<includeonly>{{Sandbox other||

[[Category:Legend templates]]

}}</includeonly>

Template:Legend/doc - Revision history

imported>Deadfire: Updating