Difference between revisions of "Template:Color/doc"

From blackwiki
Jump to navigation Jump to search
imported>Lfdder
imported>Scott
(Copyedit.)
Line 1: Line 1:
{{Documentation subpage}}
+
{{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 AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
  
The quick '''[[Template:Color]]''' can be used to add a span of text with any given text color, such as an [[RGB color model|RGB]] hex code, #C9E72A, or any of the [[web colors]]: red, blue, green, moccasin, or darkorchid, etc. The foreground text color is set, but to reset the background color, see: {{[[Template:Bg|bg]]}}.
+
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:
  
{{Tlx|color|red|Hello, world!}} {{ns|8}}gives:&nbsp; {{color|red|Hello, world!}}<br />
+
{{tbullet|color|red|Hello, world!}}
{{Tlx|color|#00F000|Hello, world!}}{{ns}}gives:&nbsp; {{color|#00F000|Hello, world!}}
+
{{tbullet|color|#00F000|Hello, world!}}
 
 
Wikitext generated:
 
::<pre>
 
<span style="color:{{{1|}}}">{{{2|}}}</span>
 
</pre>
 
 
 
See: [[Web colors]], for a list of colors. A misspelled color name will not be reported, but will cause the text to remain as black text.
 
  
 
== Performance considerations ==
 
== Performance considerations ==
The template merely uses a span tag:&nbsp; <code>&lt;span style="color:{{{1}}}">{{{2}}}&lt;/span></code>. It runs at speeds in excess of 700 per second, and so it is functionally identical to the longer span-tag markup.
+
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==
+
== Template data ==
 
{{TemplateDataHeader}}
 
{{TemplateDataHeader}}
 
<templatedata>
 
<templatedata>
Line 48: Line 43:
 
== See also ==
 
== See also ==
  
* {{tl|Background color}}
 
 
* {{tl|Resize}}
 
* {{tl|Resize}}
 
* {{tl|LinkColor}}
 
* {{tl|LinkColor}}

Revision as of 22:38, 23 March 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