Difference between revisions of "Template:Color box/doc"

From blackwiki
Jump to navigation Jump to search
imported>Useddenim
(→‎Usage: default text color)
imported>GKFX
(Convert to Format TemplateData)
Line 4: Line 4:
  
 
==Usage==
 
==Usage==
<code>&#123;&#123;color box|''color''|''text''|''text color''}}</code>
+
{{Format TemplateData|JSON=
 
+
{
*Colors are most commonly specified as either a color keyword or as the [[Web colors#Hex triplet|hexadecimal triplet]] representing an RGB combination.  See [[web colors]] for details.
+
"params": {
*If specified, the <code>text</code> is centered within the box.
+
"1": {
*If no color is specified for the text, it is displayed in either black or white, depending upon whichever has the greater contrast.
+
"label": "Color",
* The optional parameter <code>|border=</code> will change the color of the outline box. The default is black.
+
"description": "Background color of the box.",
 +
"example": "Green",
 +
"type": "string",
 +
"required": true,
 +
"suggested": true
 +
},
 +
"2": {
 +
"label": "Text",
 +
"description": "Adds text inside the box; box is otherwise an empty square.",
 +
"example": "Hello, world!",
 +
"type": "string",
 +
"suggested": true
 +
},
 +
"3": {
 +
"label": "Text color",
 +
"description": "Sets the color of the text inside the box.",
 +
"example": "Yellow",
 +
            "type": "string",
 +
"suggested": true,
 +
            "default": "Either black or white; whichever has greater contrast."
 +
},
 +
"border": {
 +
            "label": "Border color",
 +
"description": "Sets the color of the border around the box.",
 +
"example": "#FF0",
 +
            "type": "string",
 +
            "default": "black"
 +
}
 +
},
 +
"description": "<noexport><code>&#123;&#123;color box&#124;''color''&#124;''text''&#124;''text color''&#125;&#125;</code><br></noexport>Adds a rectangular color box. <li>Colors are most commonly specified as either a color keyword or as the [[Web colors#Hex triplet|hexadecimal triplet]] representing an RGB combination.  See the article [[web colors]] for details.<li>If specified, the text is centered within the box.",
 +
"format": "inline"
 +
} }}
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 37: Line 68:
  
 
== TemplateData ==
 
== TemplateData ==
{{TemplateData header}}
 
<templatedata>
 
{
 
"params": {
 
"1": {
 
"label": "Color",
 
"description": "Color of the box.",
 
"example": "Green",
 
"type": "string",
 
"required": true,
 
"suggested": true
 
},
 
"2": {
 
"label": "Text",
 
"description": "The text in the box.",
 
"example": "Hello, world!",
 
"type": "string",
 
"suggested": true
 
},
 
"3": {
 
"label": "Text color",
 
"description": "Sets the color of the text inside the box.",
 
"example": "Yellow",
 
                        "type": "string",
 
"suggested": true
 
},
 
"border": {
 
"description": "Adds border outside the box.",
 
"example": "#FF0"
 
}
 
},
 
"description": "Adds a rectangular color box.",
 
"format": "inline"
 
}
 
</templatedata>
 
  
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |

Revision as of 21:11, 11 March 2018

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

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

    Variants

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

    See also

    TemplateData