Template:Font color/doc: Difference between revisions
mNo edit summary |
mNo edit summary |
||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{tsh|fc}} | |||
__NOTOC__ | __NOTOC__ | ||
== Purpose == | == Purpose == | ||
{{ | {{tl|Font color}} or {{tl|Fc}} is how you insert colorized text, such as | ||
{{Font color|red|red}}, | {{Font color|red|red}}, | ||
{{Font color|orange|orange}}, | {{Font color|orange|orange}}, | ||
{{Font color|green|green}}, | {{Font color|green|green}}, | ||
{{ | {{fc|blue|blue|link = cat}} and | ||
{{ | {{fc|indigo|indigo}}, | ||
and [[Wikipedia:Help:Color#Color generation guide|many others]]. | and [[Wikipedia:Help:Color#Color generation guide|many others]]. | ||
You can specify its {{ | You can specify its {{fc|bg=yellow|fg=indigo|text=background}} color at the same time. | ||
{{tls|Font color}} is also how you can color wikilinks | {{tls|Font color}} is also how you can color wikilinks | ||
to something other than blue for when you need to work within background colors. | to something other than blue for when you need to work within background colors. | ||
Normally | Normally <code>[<nowiki/>[ wikilink ]]</code> → [[wikilink]], | ||
but here we use a {{tls|font color}} with {{para|link}} to create a black wikilink | but here we use a {{tls|font color}} with {{para|link}} to create a black wikilink → | ||
{{Font color|black|violet|link=yes| wikilink }} | {{Font color|black|violet|link=yes| wikilink }} | ||
You can make any text link to any page using the {{para|link}} parameter. | You can make any text link to any page using the {{para|link}} parameter. | ||
Line 25: | Line 26: | ||
== Usage == | == Usage == | ||
{{ | {{tji|Font color}} has a one-color and a two-color form: | ||
: | : {{Pre|{{((}}font color | ''color'' | ''text'' {{))}}}} | ||
: | : {{Pre|{{((}}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. | ||
: | : {{para|link|yes}} {{Rarr}} <code>{{!(n(}}''text'']]</code> | ||
: | : {{para|link|''[[wikipedia:pgn|fullpagename]]''}} {{Rarr}} <code>{{!(n(}}''fullpagename'']]</code> | ||
You can also name the other fields. | You can also name the other fields. | ||
Line 40: | Line 41: | ||
Spacing is of no concern. | Spacing is of no concern. | ||
: {{code|.}}{{tlc|font color|tan|green|text with four words}}{{code|.}} | : {{code|.}}{{tlc|font color|tan|green|text with four words}}{{code|.}} → {{code|.}}{{font color|tan|green|text with four words }}{{code|.}} | ||
: {{code|.}} {{tlc|font color|tan|green|text with four words}} {{code|.}} | : {{code|.}} {{tlc|font color|tan|green|text with four words}} {{code|.}} → {{code|.}} {{font color|tan|green|text with four words }} {{code|.}} | ||
: {{code|.}} <code><nowiki>{{font color | tan | green | text with four words }}</nowiki></code> {{code|.}} | : {{code|.}} <code><nowiki>{{font color | tan | green | text with four words }}</nowiki></code> {{code|.}} → {{code|.}} {{ font color | tan | green | text with four words }} {{code|.}} | ||
=== Parameters === | === Parameters === | ||
Line 89: | Line 90: | ||
!Renders as | !Renders as | ||
|- | |- | ||
| {{tlc|Font color|white|blue| Wikipedia:Example|link | | {{tlc|Font color|white|blue| Wikipedia:Example|link=yes}} || {{Font color|white|blue|Wikipedia:Example|link = yes}} | ||
|- | |- | ||
| {{tlc|Font color|white|blue|Wikipedia:Example|link | | {{tlc|Font color|white|blue|Wikipedia:Example|link=Wikipedia:Sandbox}} || {{Font color|white|blue|Wikipedia:Example|link = Wikipedia:Sandbox}} | ||
|- | |- | ||
| {{tlc|Font color|text | | {{tlc|Font color|text = Wikipedia:Example|link = Wikipedia:Sandbox|bg = blue|fg = white}} || {{Font color|text = Wikipedia:Example|link = Wikipedia:Sandbox|bg = blue|fg = white}} | ||
|} | |} | ||
Line 103: | Line 104: | ||
:→ [[Wikipedia:Example|{{font color|white|blue|the Wikipedia:Example page}}]] (a font-colored link), | :→ [[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}}. | a ''font color'' does not accept a wikilink, it creates wikilinks itself with {{para|link}}. | ||
* Ok - {{tlc|Font color|green|violet|Wikipedia:Example|link | * Ok - {{tlc|Font color|green|violet|Wikipedia:Example|link = yes}} → {{Font color|green|violet|Wikipedia:Example|link {{=}} yes}} (a {{para|link}} {{tlb|font color}}) | ||
* Wrong - {{tlc|Font color|green|violet|the {{!(n(}}Wikipedia:Example]] page}} {{Rarr}} {{Font color|green|violet|the [[Wikipedia:Example]] page}} (Text with | * Wrong - {{tlc|Font color|green|violet|the {{!(n(}}Wikipedia:Example]] page}} {{Rarr}} {{Font color bold|green|violet|the [[Wikipedia:Example]] page}} (Text with [<nowiki/>[wikilink brackets]] overrides the designated color) | ||
* Wrong - {{tlc|Font color|green|violet|{{!(n(}} | * Wrong - {{tlc|Font color|green|violet|an {{!(n(}}Example]]}} {{Rarr}} {{Font color bold|green| violet|an [[Example]]}} (Text with [<nowiki/>[wikilink brackets]] overrides the designated color) | ||
== TemplateData == | |||
<templatedata> | |||
{ | |||
"description": "Displays text with different font and background colors.", | |||
"params": { | |||
"1": { | |||
"label": "Text Color", | |||
"description": "The color of the text.", | |||
"type": "string", | |||
"aliases": [ "fg" ], | |||
"default": "inherited", | |||
"required": true | |||
}, | |||
"2": { | |||
"label": "Background Color", | |||
"description": "The background behind the text color.", | |||
"type": "string", | |||
"aliases": [ "bg" ], | |||
"default": "inherited", | |||
"required": false | |||
}, | |||
"3": { | |||
"label": "Text", | |||
"description": "The text to be colored.", | |||
"type": "string", | |||
"aliases": [ "text" ], | |||
"required": true | |||
}, | |||
"link": { | |||
"label": "Link", | |||
"description": "If the text is a link.", | |||
"type": "string", | |||
"suggestedvalues": [ "yes", "fullpagename" ], | |||
"required": false | |||
} | |||
} | |||
} | |||
</templatedata> | |||
<includeonly>{{sandbox other||{{testcases other|| | <includeonly>{{sandbox other||{{testcases other|| | ||
Line 111: | Line 152: | ||
<!-- Categories below this line, please --> | <!-- Categories below this line, please --> | ||
[[Category:Templates]] | [[Category:Templates]] | ||
[[Category: | [[Category:Formatting Templates]] | ||
}}}}</includeonly> | }}}}</includeonly> |
Revision as of 19:43, 17 June 2023
It contains usage information, categories and other content that is not part of the original template page.
|
Purpose
{{Font color}} or {{Fc}} 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.
{{Font color}} 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 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
{{Font color}} has a one-color and a two-color form:
{{font color| color| text }}
{{font color| 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.
{{font color | fg=color | text=text }}
{{font color | 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.
Spacing is of no concern.
.
{{font color|tan|green|text with four words}}
.
→.
text with four words.
.
{{font color|tan|green|text with four words}}
.
→.
text with four words.
.
{{font color | tan | green | text with four words }}
.
→.
text with four words.
Parameters
Parameter | Use / description | Default value |
---|---|---|
|1= |
text color | inherited |
|2= |
text | |
|link= |
=yes or =fullpagename |
- Or
Parameter | 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|white|black|white with black background}} |
white with black background |
{{Font color|#ffffff|#000000|white with black background}} (Wikipedia:hexadecimal colors) |
white with black background (Wikipedia:hexadecimal colors) |
Markup | Renders as |
---|---|
{{Font color|white|blue|Wikipedia:Example}} |
Wikipedia:Example |
{{Font color|white|blue|Wikipedia:Example}} |
Wikipedia:Example |
{{Font color}} |
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=
.
- Ok -
{{Font color|green|violet|Wikipedia:Example}}
→ Wikipedia:Example (a|link=
{{font color}}) - Wrong -
{{Font color|green|violet|the [[Wikipedia:Example]] page}}
→ the Wikipedia:Example page (Text with [[wikilink brackets]] overrides the designated color) - Wrong -
{{Font color|green|violet|an [[Example]]}}
→ an Example (Text with [[wikilink brackets]] overrides the designated color)
TemplateData
Displays text with different font and background colors.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Text Color | 1 fg | The color of the text.
| String | required |
Background Color | 2 bg | The background behind the text color.
| String | optional |
Text | 3 text | The text to be colored. | String | required |
Link | link | If the text is a link.
| String | optional |