Template:Color box

From MHOCStormont Elections
Jump to navigation Jump to search

    

Template documentation[view] [edit] [history] [purge]

Usage

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 Color box

{{color box|color|text|text color}}
Adds a rectangular color box.
  • Colors are most commonly specified as either a color keyword or as the hexadecimal triplet representing an RGB combination. See the article web colors for details.
  • If specified, the text is centered within the box.
ParameterDescriptionTypeStatus
Color1
Background color of the box.
Example
Green
Stringrequired
Text2
Adds text inside the box; box is otherwise an empty square.
Example
Hello, world!
Stringsuggested
Text color3
Sets the color of the text inside the box.
Default
Either black or white; whichever has greater contrast.
Example
Yellow
Stringsuggested
Border colorborder
Sets the color of the border around the box.
Default
black
Example
#FF0
Stringoptional

Format: inline

Test of raw TemplateData output:
<templatedata>{"description":"Adds a rectangular color box. Colors are most commonly specified as either a color keyword or as the hexadecimal triplet representing an RGB combination. See the article web colors for details.If specified, the text is centered within the box.","format":"inline",

"params":{ "1":{"suggested":true,"type":"string","description":"Background color of the box.","label":"Color","example":"Green","required":true},

"2":{"suggested":true,"type":"string","description":"Adds text inside the box; box is otherwise an empty square.","label":"Text","example":"Hello, world!"},

"3":{"suggested":true,"type":"string","description":"Sets the color of the text inside the box.","label":"Text color","example":"Yellow","default":"Either black or white; whichever has greater contrast."},

"border":{"type":"string","description":"Sets the color of the border around the box.","label":"Border color","example":"#FF0","default":"black"} }

}</templatedata>
Examples
Visual effect Markup
     {{color box|Green}}
 Default color for this text  {{color box|Yellow|Default color for this text}}
 Default color for this text  {{color box|Blue|Default color for this text}}
 Using X11 color names  {{color box|SteelBlue|'''Using X11 color names'''|Gold}}
 Using RGB hex triplets  {{color box|#012345|''Using RGB hex triplet''|#FEDCBA}}
 Red  {{color box|Yellow|Red|#f00|border=#f00}}
 bordercolor like wikitable  {{color box|white|bordercolor like wikitable|border=#A2A9B1}}

Variants

Template Description Example
{{Color box}} a small color box with black borders and text color      or  ORANGE 
{{RouteBox}} a borderless version with text color and wikilinks  ORANGE 
{{Colorbull}} a colored bullet with wikilinks
{{Legend2}} another borderless version   
{{Color sample}} a small color box with black borders
{{Swatch inline}} orange
{{Background color}} orange
{{Rail color box}} a version with more display options
(part of Module:Adjacent stations)
, Orange, etc.
{{Diagonal split color box}} a small color box split diagonally
   
   
, etc.
{{Motor type}} A small color box corresponding to the motor type
SI
A
, etc.

Supporting template

See also