Template:Legend/doc

From MicroWiki, the free micronational encyclopædia
Jump to navigation Jump to search

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
[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

[markup]

[rendering]

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-->
}}

Limitations

Using certain special characters in |text= that have meaning in wikitext can cause unexpected results. To use Template:Asterisk 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
  • Web colors

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools.

TemplateData for Legend

Shows a legend row with a colored box and a caption.

Template parameters

ParameterDescriptionTypeStatus
Color1

The color for the legend entry, in any CSS format

Example
"#6D6E00", "#ffa", "yellow"
Linerequired
Caption2

Label for the legend entry

Example
"soda" is most common
Stringsuggested
CSS border styleborder

CSS style for the legend entry's border

Stringoptional
Entry outlineoutline

CSS color for the outline of the legend entry

Example
silver
Lineoptional
Text in the entrytext

Text to be displayed in the legend entry box, i.e. within the color specified

Example
Af
Lineoptional
Text colortextcolor

CSS color of text inside the legend's colored box

Stringoptional
sizesize

Font size of the legend entry, including colored box

Stringoptional