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

From Summertime Saga Wiki
Jump to: navigation, search
m (Purpose)
m (Usage)
Line 10: Line 10:
 
== Usage ==
 
== Usage ==
  
{{tlg|code=yes|nolink=yes|font color}} has a one‐color and a two‐color form:
+
{{tlg|code=yes|nolink=yes|font color}} has a one‐color:
* {{tlg|code=yes|nolink=yes|font color|{{var|color}}|{{var|text}}}}
+
: {{tlg|code=yes|nolink=yes|font color|fg{{=}}{{var|text color}}|text{{=}}{{var|text}}}}
* {{tlg|code=yes|nolink=yes|font color|{{var|text color}}|{{var|background color}}|{{var|text}}}}
+
: {{tlg|code=yes|nolink=yes|font color|{{var|text color}}|{{var|text}}}}
 +
 
 +
And a two‐color form:
 +
: {{tlg|code=yes|nolink=yes|font color|fg{{=}}{{var|text color}}|bg{{=}}{{var|background color}}|text{{=}}{{var|text}}}}
 +
: {{tlg|code=yes|nolink=yes|font color|{{var|text color}}|{{var|background color}}|{{var|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}} produces <code>[[{{var|text}}]]</code>
+
: {{para|link|yes}} produces <code>[[{{var|text}}]]</code>
* {{para|link|[[Wikipedia:Albert Einstein]]}} produces <code>[[[[wikipedia:Albert Einstein|Albert Einstein]]]]</code>
+
: {{para|link|Erik}} produces {{code|[[Erik]]}}
 
 
You can also name the other fields:
 
* {{tlg|code=yes|nolink=yes|font color|fg{{=}}{{var|color}}|text{{=}}{{var|text}}}}
 
* {{tlg|code=yes|nolink=yes|font color|fg{{=}}{{var|text color}}|bg{{=}}{{var|background color}}|text{{=}}{{var|text}}}}
 
 
 
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 ===
  
{|class=wikitable
+
In a one‐color form:
|-
+
; {{para|fg}} or {{para|1}} : The color of the text.
!
+
; {{para|bg}} or {{para|2}} : The color of the background.
! Use / description
+
; {{para|link}} : =yes or =fullpagename. If there is a link.
! Default value
 
|-
 
| {{{1}}}
 
| {{var|text color}}
 
| inherited
 
|-
 
| {{{2}}}
 
| {{var|text}}
 
|
 
|-
 
| link
 
| =yes or =fullpagename
 
|
 
|}
 
 
 
Or
 
  
{|class=wikitable
+
In a two‐color form:
|-
+
; {{para|fg}} or {{para|1}} : The color of the text.
!
+
; {{para|bg}} or {{para|2}} : The color of the background.
! Use / description
+
; {{para|text}} or {{para|3}} : The text to display.
! Default value
+
; {{para|link}} : =yes or =fullpagename. If there is a link.
|-
 
| {{{1}}}
 
| {{var|text color}}
 
| inherited
 
|-
 
| {{{2}}}
 
| {{var|background color}}
 
| inherited
 
|-
 
| {{{3}}}
 
| {{var|text}}
 
|
 
|-
 
| link
 
| =yes or =fullpagename
 
|
 
|}
 
  
 
== Examples ==
 
== Examples ==

Revision as of 13:50, 25 July 2020

The template {{font color}} is how you insert colorized text. You can specify its background color at the same time.

Purpose

{{font color}} is also how you can color wikilinks to something other than blue for when you need to work within background colors. Normally [[Pink Cyclone]] produces Pink Cyclone, but here we use a font color with |link= to create a black wikilink → Pink Cyclone. 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>, so the page increases its readability and usability in both the wikitext and the rendered page.

Usage

{{font color}} has a one‐color:

{{font color|fg=text color|text=text}}
{{font color|text color|text}}

And a two‐color form:

{{font color|fg=text color|bg=background color|text=text}}
{{font color|text color|background color|text}}

Either form has a |link= option, for colorizing (otherwise blue or red) wikilink text:

|link=yes produces [[text]]
|link=Erik produces [[Erik]]

Parameters

In a one‐color form:

|fg= or |1= 
The color of the text.
|bg= or |2= 
The color of the background.
|link= 
=yes or =fullpagename. If there is a link.

In a two‐color form:

|fg= or |1= 
The color of the text.
|bg= or |2= 
The color of the background.
|text= or |3= 
The text to display.
|link= 
=yes or =fullpagename. If there is a link.

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|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}}]] produces the Wikipedia:Example page (a font‐colored link)
{{font color}} does not accept a wikilink, it creates wikilinks itself with |link=.
{{font color|green|violet|Wikipedia:Example}} produces Wikipedia:Example
{{font color|green|violet|the Wikipedia:Example page}} produces the Wikipedia:Example page (text with [[wikilink brackets]] overrides the designated color)