Difference between revisions of "Template:Color box/doc"
Jump to navigation
Jump to search
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.
imported>Useddenim (→Usage: default text color) |
imported>GKFX (Convert to Format TemplateData) |
||
| Line 4: | Line 4: | ||
==Usage== | ==Usage== | ||
| − | <code>{{color box | + | {{Format TemplateData|JSON= |
| − | + | { | |
| − | + | "params": { | |
| − | + | "1": { | |
| − | + | "label": "Color", | |
| − | + | "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>{{color box|''color''|''text''|''text color''}}</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 == | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | ||
Revision as of 21:11, 11 March 2018
| 40px | This is a documentation subpage for Template:Color box. It contains usage information, categories and other content that is not part of the original template page. |
Contents
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.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Color | 1 | Background color of the box.
| String | required |
| Text | 2 | Adds text inside the box; box is otherwise an empty square.
| String | suggested |
| Text color | 3 | Sets the color of the text inside the box.
| String | suggested |
| Border color | border | Sets the color of the border around the box.
| String | optional |
Format: inline
| 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 | |
| {{Motor type}} | A small color box corresponding to the motor type | Template:Motor type, etc. |
See also
- {{Infobox color}}, an infobox for the detailed description of a color.
- {{Legend}}