Template:Textcolor/doc
Purpose
{{ textcolor }} is how you insert colorized text, such as red, orange, green, blue and indigo, and many others. You can specify its background color at the same time.
{{ textcolor }} is also how you can color wikilinks
to something other than blue for when you need to work within background colors.
Normally [[ wikilink ]] → wikilink,
but here we use {{ textcolor }} with |link = to create a black wikilink →
wikilink
You can make any text link to any page using the |link = parameter.
This template will use Wikipedia:HTML5 recommendations, inserting the span tags <span style="color:color">...</span> and <span style="background-color:color">...</span>, so the page increases its readability and usability in both the wikitext and the rendered page.
Usage
{{ textcolor }} has a one-color and a two-color form:
- {{textcolor | color | text }}
- {{textcolor | text color | background color | text }}.
Either form has a |link= option, for colorizing (otherwise blue or red) wikilink text.
- |link=yes →
[[text]] - |link=fullpagename →
[[fullpagename]]
You can also name the other fields.
- {{textcolor | fg=color | text=text }}
- {{textcolor | fg=text color | bg=background color | text=text }}
You can name |fg= or |bg=, which is nice, but... if you name either of them, you must also name |text=, which is a compromise. (See Wikipedia: Help:Template#Parameters for why.)
Spacing is of no concern.
.{{textcolor|tan|green|text with four words}}.→.text with four words..{{textcolor|tan|green|text with four words}}.→.text with four words..{{ textcolor | tan | green | text with four words }}.→.text with four words.
Parameters
| Use / description | Default value | |
|---|---|---|
| {{{1}}} | text color | inherited |
| {{{2}}} | text | |
| link | =yes or =fullpagename |
- Or
| Use / description | Default value | |
|---|---|---|
| {{{1}}} | text color | inherited |
| {{{2}}} | background color | inherited |
| {{{3}}} | ||
| link | =yes or =fullpagename |
Examples
| Markup | Renders as |
|---|---|
{{ textcolor | green | green text }}
|
green text |
{{ textcolor | blue | do not style text as a link }}
|
do not style text as a link |
{{ textcolor || yellow | default text in yellow background }}
|
default text in yellow background |
{{ textcolor | yellow | text = default text in yellow background }}
|
default text in yellow background |
{{ textcolor | white | black | white with black background }}
|
white with black background |
{{ textcolor | #ffffff | #000000 | white with black background }} ([[hexadecimal colors]])
|
white with black background |
{{ textcolor | rgb(255,255,255) | rgb(0,0,0) | white with black background }}
|
white with black background |
| Markup | Renders as |
|---|---|
{{ textcolor | white | blue | Wikipedia:Example | link = yes }}
|
Wikipedia:Example |
{{ textcolor | white | blue | Wikipedia:Example | link = Wikipedia:Sandbox }}
|
Wikipedia:Example |
{{ textcolor | text = Wikipedia:Example | link = Wikipedia:Sandbox | bg
= blue | fg = white }}
|
Wikipedia:Example |
The |link = parameter is a good way to colorize wikilinks,
and it is about as much typing as the pipe trick.
Although a wikilink accepts textcolor (or other template or markup):
[[Wikipedia:Example | {{textcolor|white|blue|the Wikipedia:Example page}}- → the Wikipedia:Example page (a textcolor-colored link),
textcolor does not accept a wikilink, it creates wikilinks itself with |link =.
- ✅ {{ textcolor | green | violet | Wikipedia:Example | link=yes }} → Wikipedia:Example (a
|link ={{ textcolor }}) - ❌{{ textcolor | green | violet | the [[Wikipedia:Example]] page}} → the Wikipedia:Example page (Text with [[wikilink brackets]] overrides the designated color)
- ❌{{ textcolor | green | violet | [[Wikipedia:Exammple]] }} → the Wikipedia:Exammple page (Text with [[wikilink brackets]] overrides the designated color)