Difference between revisions of "Template:Font color/doc"

From blackwiki
Jump to navigation Jump to search
imported>Cpiral
(+ template high-use)
imported>Crissov
(see also: {{tl|coltit}} — colored table header cell)
 
(23 intermediate revisions by 18 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 
{{Warning|1={{big|'''Links should clearly be identifiable as links to readers'''.}}<br />Refrain from implementing colored links that may impede user ability to distinguish links from regular text, or color links for purely aesthetic reasons. See the guides to editing articles for accessibility at  [[WP:CONTRAST|contrast]], [[ Wikipedia:Manual of Style/Accessibility|accessibility]] and [[WP:NAVBOXCOLOUR|navbox colors]].}}
 
{{Warning|1={{big|'''Links should clearly be identifiable as links to readers'''.}}<br />Refrain from implementing colored links that may impede user ability to distinguish links from regular text, or color links for purely aesthetic reasons. See the guides to editing articles for accessibility at  [[WP:CONTRAST|contrast]], [[ Wikipedia:Manual of Style/Accessibility|accessibility]] and [[WP:NAVBOXCOLOUR|navbox colors]].}}
<includeonly>{{High-use|14,000+}}</includeonly>
+
{{High-use| 90150 }}
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
  
 
== Purpose ==
 
== Purpose ==
This is how you insert colorized text, such as
+
{{tl | Font color }} 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|yellow|yellow|link=yes}},
+
{{ font color | green | green }},
{{font color|green|green}},
+
{{ font color | blue | blue | link = cat }} and
{{font color|blue|blue|link=cat}} and
+
{{ font color | indigo | indigo }},
{{font color|indigo|indigo}},
 
{{font color|violet|violet}},
 
 
and [[Help:Color#Color generation guide|many others]].
 
and [[Help:Color#Color generation guide|many others]].
 +
You can specify its {{ font color | bg=yellow | fg=indigo | text=background }} color at the same time.
  
It's needed for matching a color theme such as in sports templates.
+
{{tl | Font color }} is also how you can color wikilinks
You can specify a {{font color|bg=yellow|text=background}} color too.
+
to something other than blue for when you need to work within background colors.
 +
Normally <kbd>[<nowiki/>[ wikilink ]]</kbd> &rarr; [[wikilink]],
 +
but here we use a {{tl | font color }} with {{para | link }} to create a black wikilink &rarr;
 +
{{ font color | black | violet | link=yes | &nbsp;&nbsp;&nbsp;wikilink&nbsp;&nbsp;&nbsp; }}
 +
You can make any text link to any page using the {{para|link}} parameter.
  
You can make any text link to any page. (See "yellow" and "blue" above.)
+
This template will use [[Wikipedia:HTML5]] recommendations,  
 
+
inserting the span tags
For example, giving your plain <kbd>[<nowiki/>[wikilink]]</kbd>, you get
+
{{tag|span|params=style="color:''color''"}} and
 
+
{{tag|span|params=style="background-color:''color''"}}, so the page increases its readability and usability in both the wikitext and the rendered page.
{| class="wikitable" style=color:green
 
|-
 
! header 1
 
! header 2
 
! header 3
 
|-
 
| row 1, cell 1 [[wikilink]]
 
| row 1, cell 2
 
| row 1, cell 3
 
|-
 
| row 2, cell 1
 
| row 2, cell 2
 
| row 2, cell 3
 
|}
 
 
 
You need {<nowiki/>{font color | green | wikilink | link = yes }}
 
 
 
{| class="wikitable" style=color:green
 
|-
 
! header 1
 
! header 2
 
! header 3
 
|-
 
| row 1, cell 1 {{font color|green|wikilink|link=yes}}
 
| row 1, cell 2
 
| row 1, cell 3
 
|-
 
| row 2, cell 1
 
| row 2, cell 2
 
| row 2, cell 3
 
|}
 
 
 
Font color will use the latest [[Wikipedia:HTML5]] recommendations,
 
inserting the span tag attributes
 
: <code>style=background-color</code>:
 
: <code>style=color</code>:
 
for you, so your page increases its readability and usability in the wikitext and its rendering.
 
  
 
== Usage ==
 
== Usage ==
  
{{tlf|Font color}} has a one-color and a two-color form:
+
{{tlf | Font color }} has a one-color and a two-color form:
: <kbd>{<nowiki/>{font color|''color''|''text''}}</kbd>
+
: <kbd>{<nowiki/>{font color | ''color'' | ''text'' }}</kbd>
: <kbd>{<nowiki/>{font color|''text color''|''background color''|''text''}}</kbd>.
+
: <kbd>{<nowiki/>{font color | ''text color'' | ''background color'' | ''text'' }}</kbd>.
  
 
Either form has a <kbd>|link=</kbd> option, for colorizing (otherwise blue or red) wikilink text.
 
Either form has a <kbd>|link=</kbd> option, for colorizing (otherwise blue or red) wikilink text.
Line 71: Line 37:
  
 
You can also name the other fields.
 
You can also name the other fields.
: <kbd>{<nowiki/>{font color|fg=''color''|text=''text''}}</kbd>
+
: <kbd>{<nowiki/>{font color | fg=''color'' | text=''text'' }}</kbd>
: <kbd>{<nowiki/>{font color|fg=''text color''|bg=''background color''|text=''text''}}</kbd>
+
: <kbd>{<nowiki/>{font color | fg=''text color'' | bg=''background color'' | text=''text'' }}</kbd>
 
You can name <kbd>|fg=</kbd> or <kbd>|bg=</kbd>, which is nice, but...
 
You can name <kbd>|fg=</kbd> or <kbd>|bg=</kbd>, which is nice, but...
 
if you name either of them, you must also name <kbd>|text=</kbd>, which is a compromise.
 
if you name either of them, you must also name <kbd>|text=</kbd>, which is a compromise.
 
(See [[Help:Template#Parameters]] for why.)
 
(See [[Help:Template#Parameters]] for why.)
  
Spacing is never of any concern.
+
Spacing is of no concern.
:<code>.</code>{<nowiki/>{ font color | tan | green |{{spaces|3}}label{{spaces|3}}with{{spaces|4}}four{{spaces|5}}words{{spaces|3}}}}<code>.</code> &rarr; <code>.</code>{{ font color | tan | green | label  with   four     words}}<code>.</code>
+
:<code>.</code><kbd>{<nowiki/>{font color|tan|green|text with four words}}</kbd><code>.</code> &rarr; <code>.</code>{{font color|tan|green|text with four words }}<code>.</code>
:<code>.</code> {<nowiki/>{ font color | fg = tan | bg = green | text = {{spaces|3}} label {{spaces|3}} with{{spaces|4}} four{{spaces|5}} words{{spaces|3}} }} <code>.</code> &rarr;  <code>.</code> {{ font color | fg = tan | bg = green |  text = label  with    four    words}} <code>.</code>
+
:<code>.</code><kbd> {<nowiki/>{font color|tan|green|text with four words}} </kbd><code>.</code> &rarr; <code>.</code> {{font color|tan|green|text with four words }} <code>.</code>
 +
:<code>.</code><kbd> {<nowiki/>{ font color | tan | green | text with four words }} </kbd><code>.</code> &rarr;  <code>.</code> {{ font color | tan | green |  text   with    four    words }} <code>.</code>
  
===Parameters===
+
=== Parameters ===
 
{{Aligned table
 
{{Aligned table
 
  |cols=3 |style=padding:0.5em 0;line-height:1.35em;margin-bottom:1.0em;
 
  |cols=3 |style=padding:0.5em 0;line-height:1.35em;margin-bottom:1.0em;
Line 113: Line 80:
 
!Renders as
 
!Renders as
 
|-
 
|-
|<code><nowiki>{{font color|green|green text}}</nowiki></code>
+
| <code><nowiki>{{ font color | green | green text }}</nowiki></code>
|{{font color|green|green text}}
+
| {{ font color | green | green text }}
 +
|-
 +
| <code><nowiki>{{ font color | blue | do not style text as a link }}</nowiki></code>
 +
| {{ font color | blue | do not style text as a link }}
 
|-
 
|-
|<code><nowiki>{{font color|blue|do not style text as a link}}</nowiki></code>
+
| <code>{<nowiki/>{ font color'''{{big | {{! }}<nowiki/>{{! }} }}'''yellow | default text in yellow background }}</code>
|{{font color|blue|do not style text as a link}}
+
| {{ font color | | yellow | default text in yellow background }}
 
|-
 
|-
|<code><nowiki>{{font color|white|black|white with black background}}</nowiki></code>
+
| <code>{<nowiki/>{ font color'''{{big | {{! }} }}'''bg=yellow | text = default text in yellow background }}</code>
|{{font color|white|black|white with black background}}
+
| {{ font color | bg=yellow | text = default text in yellow background }}
 
|-
 
|-
||<code>{<nowiki/>{font color'''{{big|{{!}}<nowiki/>{{!}}}}'''yellow|default text in yellow background}}</code>
+
| <code><nowiki>{{ font color | white | black | white with black background }}</nowiki></code>
|{{font color||yellow|default text in yellow background}}
+
| {{ font color | white | black | white with black background }}
 
|-
 
|-
||<code>{<nowiki/>{font color'''{{big|{{!}}}}'''bg=yellow|text=default text in yellow background}}</code>
+
| <code><nowiki>{{ font color | #ffffff | #000000 | white with black background }} ([[hexadecimal colors]]) </nowiki></code>
|{{font color|bg=yellow|text=default text in yellow background}}
+
| {{ font color | #ffffff | #000000 | white with black background}} ([[hexadecimal colors]])
 
|}
 
|}
  
Line 133: Line 103:
 
!Renders as
 
!Renders as
 
|-
 
|-
|<code><nowiki>{{font color|white|blue|Wikipedia:Example|link=yes}}</nowiki></code></code>
+
| <code><nowiki>{{ font color | white | blue | Wikipedia:Example | link = yes }}</nowiki></code>
|{{font color|white|blue|Wikipedia:Example|link=yes}}
+
| {{ font color | white | blue | Wikipedia:Example | link = yes }}
 
|-
 
|-
|<code><nowiki>{{font color|white|blue|Example|link=Wikipedia:Sandbox}}</nowiki></code>
+
| <code><nowiki>{{ font color | white | blue | Wikipedia:Example | link = Wikipedia:Sandbox }}</nowiki></code>
|{{font color|white|blue|Example|link=Wikipedia:Sandbox}}
+
| {{ font color | white | blue | Wikipedia:Example | link = Wikipedia:Sandbox }}
 
|-
 
|-
|<code><nowiki>{{font color|text=Example|link=Wikipedia:Sandbox|bg=blue|fg=white}}</nowiki></code>
+
| <code><nowiki>{{ font color | text = Wikipedia:Example | link = Wikipedia:Sandbox | bg
|{{font color|text=Example|link=Wikipedia:Sandbox|bg=blue|fg=white}}
+
= blue | fg = white }}</nowiki></code>
 +
| {{ font color | text = Wikipedia:Example | link = Wikipedia:Sandbox | bg = blue | fg = white }}
 
|}
 
|}
  
 
The {{para|link}} parameter is a good way to colorize wikilinks,
 
The {{para|link}} parameter is a good way to colorize wikilinks,
 
and it is about as much typing as the [[wp:pipe trick|pipe trick]].
 
and it is about as much typing as the [[wp:pipe trick|pipe trick]].
*<code>[<nowiki />[Wikipedia:Sandbox|{<nowiki />{font color|white|blue|Example}}]]</code> &rarr; [[Wikipedia:Sandbox|{{font color|white|blue|Example}}]]  Linked by the pipe trick. {{OK}}
 
*{{#invoke:DemoTemplate|font color|white|blue|Example|link=Wikipedia:Sandbox}}  Linked by {{tl|font color}} {{OK}}
 
*{{#invoke:DemoTemplate|font color|red|[[Wikipedia:Sandbox]]}} Not "red" like it said, because text is a wikilink. {{cross}}
 
*{{#invoke:DemoTemplate|font color|white|green|[[Wikipedia:Sandborax]]}}  Not white on green: text is a wikilink. {{cross}}
 
  
<span style=background-color:yellow>
+
Although a wikilink accepts a ''font color'' (or other template or markup):
This span is style=background-color:yellow.
+
:<code>{{big|[<nowiki/>[}}Wikipedia:Example{{big|{{!}}}}{<nowiki />{font color|white|blue|the Wikipedia:Example page}}{{big|]]}}</code>
{{#invoke:DemoTemplate|font color|red|some red text}}.<br />
+
:→ [[Wikipedia:Example | {{ font color | white | blue | the Wikipedia:Example page}}]] (a font-colored link),
Link with {{#invoke:DemoTemplate|font color|purple|''The Color Purple''|link=The Color Purple}}.
+
a ''font color'' does not accept a wikilink, it creates wikilinks itself with {{para|link}}.
{{spaces|5}}Span ending.</span>
+
*{{OK }} {<nowiki/>{ font color | green | violet | Wikipedia:Example | link=yes }} → {{ font color | green | violet | Wikipedia:Example | link=yes }} (a {{para|link}} {{tl | font color }})
 +
*{{cross }}{<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)
 +
*{{cross }}{<nowiki/>{ font color | green | violet | [<nowiki/>[Wikipedia:Exammple]] }} → {{ font color | green | violet | the [[Wikipedia:Exammple]] page }} (Text with [<nowiki/>[wikilink brackets]] overrides the designated color)
 
<!--
 
<!--
  
 
--><includeonly>For more examples see [[/testcases]].</includeonly>
 
--><includeonly>For more examples see [[/testcases]].</includeonly>
For actual mainspace template usage, here are search links for  
+
For actual mainspace template usage, here are search links for
* {{sl|hastemplate:"font color"|label=all usage}}.
+
* {{sl | hastemplate:"font color" | label=all usage }}.
* {{template usage|font color|pattern=link=|prefix=:|label=where <code>{{!}}link=</code> is used}}.
+
* {{template usage | font color | pattern=link= | prefix=: | label=where <code>{{! }}link=</code> is used }}.
* {{sl|hastemplate: "font color" prefix:F}}
+
* {{sl | hastemplate: "font color" prefix:F }} showing its use in articles whose title begins with the letter "F".
  
 
==See also==
 
==See also==
Line 171: Line 140:
 
* {{tl|color}}
 
* {{tl|color}}
 
* {{tl|background color}}
 
* {{tl|background color}}
 +
* {{tl|coltit}} — colored table header cell
 
* {{tl|color contrast ratio}}
 
* {{tl|color contrast ratio}}
 
* {{tl|hilite}}
 
* {{tl|hilite}}
Line 176: Line 146:
 
* {{tl|tq}}
 
* {{tl|tq}}
 
* {{tl|xt}}
 
* {{tl|xt}}
<includeonly>
+
 
 +
<includeonly>{{sandbox other||
 
<!-- categories -->
 
<!-- categories -->
 
[[Category:Text color templates]]
 
[[Category:Text color templates]]
 +
}}
 
</includeonly>
 
</includeonly>

Latest revision as of 07:36, 27 February 2020

Purpose

{{ Font color }} 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. (See Help:Template#Parameters for why.)

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

Script error: No such module "aligned table".

Or

Script error: No such module "aligned table".

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 }} ([[hexadecimal colors]]) white with black background (hexadecimal colors)
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=.

  1. REDIRECT Template:Xmark

{{ font color | green | violet | the [[Wikipedia:Example]] page}} → the Wikipedia:Example page (Text with [[wikilink brackets]] overrides the designated color)

  1. REDIRECT Template:Xmark

{{ font color | green | violet | [[Wikipedia:Exammple]] }} → the Wikipedia:Exammple page (Text with [[wikilink brackets]] overrides the designated color)

For actual mainspace template usage, here are search links for

See also