Difference between revisions of "Template:Color box/doc"
Jump to navigation
Jump to search
imported>Useddenim m (Reverted edits by Wassan.anmol (talk) to last version by Useddenim) |
imported>WhatamIdoing (Undid revision 697149084 by Useddenim (talk) Rv blanking of WP:TemplateData) |
||
| Line 51: | Line 51: | ||
[[zh:Template:Color box]] | [[zh:Template:Color box]] | ||
}}<!--(end #ifeq)--></includeonly> | }}<!--(end #ifeq)--></includeonly> | ||
| + | <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": "border=#FF0" | ||
| + | } | ||
| + | }, | ||
| + | "description": "Adds a rectangular color box.", | ||
| + | "format": "inline" | ||
| + | } | ||
| + | </templatedata> | ||
Revision as of 18:54, 29 December 2015
| 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. |
Usage
{{color box|color|text|text color}}
- Colors are most commonly specified as either a color keyword or as the hexadecimal triplet representing an RGB combination. See web colors for details.
- If specified, the
textis centered within the box. - If no color is specified for the text, it is displayed using the default style foreground color as prescribed by CSS. For most users this is black.
- The optional parameter
|border=will change the color of the outline box. The default is black.
| Visual effect | Markup |
|---|---|
{{color box|Green}}
| |
| Default color for this text | {{color box|Yellow|Default color for this text}}
|
| White text in a blue box | {{color box|Blue|White text in a blue box|White}}
|
| Using X11 color names | {{color box|SteelBlue|'''Using X11 color names'''|Cornsilk}}
|
| 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}}
Adds a rectangular color box.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Color | 1 | Color of the box.
| String | required |
| Text | 2 | The text in the box.
| String | suggested |
| Text color | 3 | Sets the color of the text inside the box.
| String | suggested |
| Border | border | Adds border outside the box.
| Unknown | optional |