Difference between revisions of "Template:Font color/doc"
m (→Usage) |
m |
||
Line 1: | Line 1: | ||
== Purpose == | == Purpose == | ||
− | { | + | {{tl|Font color}} is how you insert colorized text, such as {{font color|red|red}}, {{font color|orange|orange}}, {{font color|green|green}}, {{font color|blue|blue}} and {{font color|indigo|indigo}}, and many others. |
You can specify its {{font color|bg=yellow|fg=indigo|text=background}} color at the same time. | You can specify its {{font color|bg=yellow|fg=indigo|text=background}} color at the same time. | ||
− | { | + | {{tl|Font color}} is also how you can color wikilinks to something other than blue for when you need to work within background colors. Normally <nowiki>[[wikilink]]</nowiki> → [[wikilink]], but here we use a font color with {{para|link}} to create a black wikilink → {{font color|black|violet|link=yes|wikilink}}. You can make any text link to any page using the {{para|link}} parameter. |
− | This template uses the latest [[Wikipedia:HTML5]] recommendations, inserting the span tags <nowiki><span style=color:color>...</span></nowiki> and <nowiki><span style=background-color:color>...</span></nowiki> for you, so your page increases its readability and usability in both the wikitext and the rendered page. | + | This template uses the latest [[Wikipedia:HTML5|HTML5]] recommendations, inserting the span tags <nowiki><span style=color:color>...</span></nowiki> and <nowiki><span style=background-color:color>...</span></nowiki> for you, so your page increases its readability and usability in both the wikitext and the rendered page. |
== Usage == | == Usage == | ||
− | { | + | {{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 | + | Either form has a {{para|link}} option, for colorizing (otherwise blue or red) wikilink text: |
− | + | * |link=yes → <code>[<nowiki/>[''text'']]</code> | |
− | + | * |link=''[[fullpagename]]'' → <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 | + | |
+ | You can name {{para|fg}}<code> 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 === | ||
Line 64: | Line 65: | ||
| | | | ||
|- | |- | ||
+ | |||
+ | [[Category:Documentation subpages]] | ||
| link | | link | ||
| =yes or =''fullpagename'' | | =yes or =''fullpagename'' | ||
Line 114: | Line 117: | ||
: <code>[<nowiki/>[Wikipedia:Example|{<nowiki />{font color|white|blue|the Wikipedia:Example page}}]]</code> → [[Wikipedia:Example|{{font color|white|blue|the Wikipedia:Example page}}]] (a font-colored link) | : <code>[<nowiki/>[Wikipedia:Example|{<nowiki />{font color|white|blue|the Wikipedia:Example page}}]]</code> → [[Wikipedia:Example|{{font color|white|blue|the Wikipedia:Example page}}]] (a font-colored link) | ||
A ''font color'' does not accept a wikilink, it creates wikilinks itself with {{para|link}}.<br> | A ''font color'' does not accept a wikilink, it creates wikilinks itself with {{para|link}}.<br> | ||
− | ✓ {<nowiki/>{ font color | green | violet | Wikipedia:Example | link=yes }} → {{font color|green|violet|Wikipedia:Example|link=yes}} (a {{para|link}} {{tl|font color}})<br> | + | {{font color|green|✓}} {<nowiki/>{ font color | green | violet | Wikipedia:Example | link=yes }} → {{font color|green|violet|Wikipedia:Example|link=yes}} (a {{para|link}} {{tl|font color}})<br> |
− | ✗ {<nowiki/>{ font color | green | violet | the [<nowiki/>[Wikipedia:Example]] page }} → {{font color|green|violet|the [[Wikipedia:Example]] page}} (text with [<nowiki/>[wikilink brackets]] overrides the designated color) | + | {{font color|red|✗}} {<nowiki/>{ font color | green | violet | the [<nowiki/>[Wikipedia:Example]] page }} → {{font color|green|violet|the [[Wikipedia:Example]] page}} (text with [<nowiki/>[wikilink brackets]] overrides the designated color) |
Revision as of 10:30, 5 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=yes →
[[text]]
- |link=fullpagename →
[[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)