Difference between revisions of "Template:Color/doc"
(←Replaced content with 'Lies') |
imported>Greyjoy (Undid revision 732644185 by 66.87.134.148 (talk)) |
||
| Line 1: | Line 1: | ||
| − | + | {{Documentation subpage}} __NOTOC__ | |
| + | <includeonly>{{High-risk|122,000+}}</includeonly> | ||
| + | <!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE --> | ||
| + | |||
| + | This template can be used to specify the foreground color of a span of text. Acceptable values are [[RGB color model|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 {{tl|background color}}. | ||
| + | |||
| + | ===Usage=== | ||
| + | * {{tlx|color|name of color or hex code of color|Text}} | ||
| + | |||
| + | For example: | ||
| + | |||
| + | {{tbullet|color|red|Hello, world!}} | ||
| + | {{tbullet|color|#00F000|Hello, world!}} | ||
| + | |||
| + | If the second parameter is omitted, the color value is displayed as text: | ||
| + | |||
| + | {{tbullet|color|#00F000}} | ||
| + | {{tbullet|color|red}} | ||
| + | |||
| + | ===Performance considerations=== | ||
| + | The template generates an HTML span tag: | ||
| + | :{{code|<nowiki><span style="color:{{{1}}}">{{{2}}}</span></nowiki>}} | ||
| + | It runs at speeds in excess of 700 per second, and so is functionally identical to using the HTML markup directly. | ||
| + | |||
| + | ===Template data=== | ||
| + | {{TemplateDataHeader}} | ||
| + | <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=== | ||
| + | * {{tl|resize}} | ||
| + | * {{tl|linkcolor}} | ||
| + | * {{tl|font color}} – sets both text and background color | ||
| + | * {{tl|background color}} – sets background color only | ||
| + | |||
| + | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | ||
| + | | <!-- CATEGORIES BELOW THIS LINE, PLEASE: --> | ||
| + | [[Category:Text color templates| ]] | ||
| + | }}</includeonly> | ||
Revision as of 09:01, 2 August 2016
| This is a documentation subpage for Template:Color. It contains usage information, categories and other content that is not part of the original template page. |
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:
Template:Tbullet Template:Tbullet
If the second parameter is omitted, the color value is displayed as text:
Template:Tbullet Template:Tbullet
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
The color template can be used to add a span of text with any given text color
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Color | 1 | CSS name of color or hex code of color, e.g. 'red' or '#00F000'. | String | required |
| Text | 2 | The string of text to be formatted in the desired color | String | required |
See also
- {{resize}}
- {{linkcolor}}
- {{font color}} – sets both text and background color
- {{background color}} – sets background color only