Difference between revisions of "Template:Color box/doc"
Jump to navigation
Jump to search
imported>Useddenim (Shortcuts/Redirects) |
imported>Useddenim (→Usage: default text color) |
||
| Line 8: | Line 8: | ||
*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. | *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. | ||
*If specified, the <code>text</code> is centered within the box. | *If specified, the <code>text</code> is centered within the box. | ||
| − | *If no color is specified for the text, it is displayed | + | *If no color is specified for the text, it is displayed in either black or white, depending upon whichever has the greater contrast. |
* The optional parameter <code>|border=</code> will change the color of the outline box. The default is black. | * The optional parameter <code>|border=</code> will change the color of the outline box. The default is black. | ||
| Line 20: | Line 20: | ||
| {{color box|Yellow|Default color for this text}} || <code><nowiki>{{color box|Yellow|Default color for this text}}</nowiki></code> | | {{color box|Yellow|Default color for this text}} || <code><nowiki>{{color box|Yellow|Default color for this text}}</nowiki></code> | ||
|- | |- | ||
| − | | {{color box|Blue| | + | | {{color box|Blue|Default color for this text}} || <code><nowiki>{{color box|Blue|Default color for this text}}</nowiki></code> |
|- | |- | ||
| − | | {{color box|SteelBlue|'''Using X11 color names'''| | + | | {{color box|SteelBlue|'''Using X11 color names'''|Gold}} || <code><nowiki>{{color box|SteelBlue|'''</nowiki>Using [[X11 color names]]<nowiki>'''|Gold}}</nowiki></code> |
|- | |- | ||
| {{color box|#012345|''Using RGB hex triplets''|#FEDCBA}} || <code><nowiki>{{color box|#012345|''</nowiki>Using [[Web colors#Hex triplet|RGB hex triplet]]<nowiki>''|#FEDCBA}}</nowiki></code> | | {{color box|#012345|''Using RGB hex triplets''|#FEDCBA}} || <code><nowiki>{{color box|#012345|''</nowiki>Using [[Web colors#Hex triplet|RGB hex triplet]]<nowiki>''|#FEDCBA}}</nowiki></code> | ||
Revision as of 22:35, 11 December 2017
| 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
{{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 in either black or white, depending upon whichever has the greater contrast.
- 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}}
|
| 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}}
TemplateData
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
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 |