Template:Color/doc
This is a documentation subpage for Template:Color. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
Prose text intended for readers should never be manually colored. (MOS:PROSECOLOR) |
This template can be used to specify the foreground color of a span of text. Acceptable values are RGB hex codes, e.g. #C9E72A, or any of the web colors: red, blue, green, moccasin, darkorchid, etc. To set the background color of a span of text, use {{background color}}.
Usage
{{color|name of color or hex code of color|Text}}
For example:
{{color|red|Hello, world!}}
→ Hello, world!{{color|#00F000|Hello, world!}}
→ Hello, world!
If the second parameter is omitted, the color value is displayed as text:
{{color|#00F000}}
→ #00F000{{color|red}}
→ red
Performance considerations
The template generates an HTML span tag:
<span style="color:{{{1}}}">{{{2}}}</span>
It runs at speeds in excess of 700 per second, and so is functionally identical to using the HTML markup directly.
Template data
TemplateData for Color
<templatedata> { "description": "The color template can be used to add a span of text with any given text color", "params": { "1": { "label": "Color", "description": "CSS name of color or hex code of color, e.g. 'red' or '#00F000'.", "type": "string", "required": true }, "2": { "label": "Text", "description": "The string of text to be formatted in the desired color", "type": "string", "suggested": true } } } </templatedata>
Redirects
{{COLOR}}
{{Colored text}}
{{Colour}}
{{COLOUR}}
{{Fgcolor}}
See also
- {{resize}}
- {{colored link}}
- {{background color}}
- {{font color}} – allows setting both text and background color
- {{coltit}} – colored table header cell