Difference between revisions of "Template:Color/doc"

From blackwiki
Jump to navigation Jump to search
imported>Redrose64
(→‎See also: add {{background color}} and brief explns)
imported>Sardanaphalus
(sandbox non-categorization, heading level)
Line 1: Line 1:
 
{{Documentation subpage}} __NOTOC__
 
{{Documentation subpage}} __NOTOC__
<includeonly>{{high-use| 33,000+ }}</includeonly>
+
<includeonly>{{High-use|33,000+}}</includeonly>
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+
<!-- 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}}.
 
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 ==
+
===Usage===
 
+
* {{tlx|color|name of color or hex code of color|Text}}
* {{Tlx|color|name of color or hex code of color|Text}}
 
  
 
For example:
 
For example:
Line 14: Line 13:
 
{{tbullet|color|#00F000|Hello, world!}}
 
{{tbullet|color|#00F000|Hello, world!}}
  
== Performance considerations ==
+
===Performance considerations===
 
The template generates an HTML span tag:
 
The template generates an HTML span tag:
 
:{{code|<nowiki><span style="color:{{{1}}}">{{{2}}}</span></nowiki>}}
 
:{{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.
 
It runs at speeds in excess of 700 per second, and so is functionally identical to using the HTML markup directly.
  
== Template data ==
+
===Template data===
 
{{TemplateDataHeader}}
 
{{TemplateDataHeader}}
 
<templatedata>
 
<templatedata>
Line 41: Line 40:
 
</templatedata>
 
</templatedata>
  
== See also ==
+
===See also===
 +
* {{tl|resize}}
 +
* {{tl|linkcolor}}
 +
* {{tl|font color}} – sets both text and background color
 +
* {{tl|background color}} – sets background color only
  
* {{tl|Resize}}
+
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
* {{tl|LinkColor}}
+
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
* {{tl|Font color}} – sets both text and background color
 
* {{tl|Background color}} – sets background color only
 
 
 
<includeonly>
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
 
[[Category:Text color templates| ]]
 
[[Category:Text color templates| ]]
 
 
</includeonly>
 
</includeonly>

Revision as of 21:57, 26 August 2014


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

Performance considerations

The template generates an HTML span tag:

&lt;span style="color:{{{1}}}"&gt;{{{2}}}&lt;/span&gt;

It runs at speeds in excess of 700 per second, and so is functionally identical to using the HTML markup directly.

Template data

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

The color template can be used to add a span of text with any given text color

Template parameters

ParameterDescriptionTypeStatus
Color1

CSS name of color or hex code of color, e.g. 'red' or '#00F000'.

Stringrequired
Text2

The string of text to be be formatted in the desired color

Stringrequired

See also