Difference between revisions of "Template:Font color/doc"
m |
m (→Usage) |
||
| Line 11: | Line 11: | ||
{{tl|Font color}} has a one-color and a two-color form: | {{tl|Font color}} has a one-color and a two-color form: | ||
| − | * | + | * {{tlx|font color|''color''|''text''}} |
| − | * | + | * {{tlx|font color|''text color''|''background color''|''text''}} |
Either form has a {{para|link}} option, for colorizing (otherwise blue or red) wikilink text: | Either form has a {{para|link}} option, for colorizing (otherwise blue or red) wikilink text: | ||
| − | * |link=yes | + | * <code>|link=yes</code> produces <code>[<nowiki/>[''text'']]</code> |
| − | * |link=''[[fullpagename]]'' | + | * <code>|link=''[[fullpagename]]''</code> produces <code>[<nowiki/>[''fullpagename'']]</code> |
You can also name the other fields: | You can also name the other fields: | ||
| − | * | + | * {{tlx|font color|fg{{=}}''color''|text{{=}}''text''}} |
| − | * | + | * {{tlx|font color|fg{{=}}''text color''|bg{{=}}''background color''|text{{=}}''text''}} |
| − | You can name {{para|fg}} | + | You can name {{para|fg}} or {{para|bg}}, which is nice, but if you name either of them, you must also name {{para|text}}, which is a compromise. |
=== Parameters === | === Parameters === | ||
Revision as of 16:01, 9 June 2019
Contents
Purpose
Template:Tl 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.
Template:Tl 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 a font color with |link= to create a black wikilink → wikilink. You can make any text link to any page using the |link= parameter.
This template uses the latest HTML5 recommendations, inserting the span tags <span style=color:color>...</span> and <span style=background-color:color>...</span> for you, so your page increases its readability and usability in both the wikitext and the rendered page.
Usage
Template:Tl has a one-color and a two-color form:
Either form has a |link= option, for colorizing (otherwise blue or red) wikilink text:
|link=yesproduces[[text]]|link=fullpagenameproduces[[fullpagename]]
You can also name the other fields:
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.
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}}} | text | |
| link | =yes or =fullpagename |
Examples
| Markup | Renders as |
|---|---|
{{ font color | green | green text }}
|
green text |
{{ font color | blue | do not style text as a link }}
|
do not style text as a link |
{{ font color | | yellow | default text in yellow background }}
|
default text in yellow background |
{{ font color | bg=yellow | text = default text in yellow background }}
|
default text in yellow background |
{{ font color | white | black | white with black background }}
|
white with black background |
{{ font color | #ffffff | #000000 | white with black background }}
|
white with black background |
| Markup | Renders as |
|---|---|
{{ font color | white | blue | Wikipedia:Example | link = yes }}
|
Wikipedia:Example |
{{ font color | white | blue | Wikipedia:Example | link = Wikipedia:Sandbox }}
|
Wikipedia:Example |
{{ font color | 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 a font color (or other template or markup):
[[Wikipedia:Example|{{font color|white|blue|the Wikipedia:Example page}}]]→ the Wikipedia:Example page (a font-colored link)
A font color does not accept a wikilink, it creates wikilinks itself with |link=.
✓ {{ font color | green | violet | Wikipedia:Example | link=yes }} → Wikipedia:Example (a |link= Template:Tl)
✗ {{ font color | green | violet | the [[Wikipedia:Example]] page }} → the Wikipedia:Example page (text with [[wikilink brackets]] overrides the designated color)