Difference between revisions of "Template:Color/doc"

Latest revision as of 21:57, 15 July 2015

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

       "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",
                       "required": true
               }
       }

} </templatedata>

See also

• {{resize}}
• {{linkcolor}}
• {{font color}} – sets both text and background color
• {{background color}} – sets background color only