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

From blackwiki
Jump to navigation Jump to search
imported>Cpiral
(+ new section "Purpose". I just needed to see the span tags for use on another wiki. Thanks.)
imported>Cpiral
(document named parameters: write Usage; edit parameters tables, add one example to each of the examples table)
Line 13: Line 13:
  
 
==Usage==
 
==Usage==
==Parameters==
+
== Usage ==
 +
 
 +
{{tlf|Font color}} has two forms:
 +
: <kbd>{<nowiki/>{font color|''color''|''text''}}</kbd>
 +
: <kbd>{<nowiki/>{font color|''text color''|''background color''|''text''}}</kbd>.
 +
 
 +
Either form has a <kbd>|link=</kbd> option for wikilinking the colorized text.
 +
: <kbd>|link{{=}}yes</kbd> &rarr; <code>[<nowiki/>[''text'']]</code>
 +
: <kbd>|link=''[[wp:pgn|fullpagename]]''</kbd> &rarr; <code>[<nowiki/>[''fullpagename'']]</code>
 +
 
 +
You can also name the other fields.
 +
: <kbd>{<nowiki/>{font color|fg=''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...
 +
if you name either of them, you must also name <kbd>|text=</kbd>, which is a compromise.
 +
(See [[Help:Template#Parameters]] for why.)
 +
 
 +
===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;
 
  |col1style=font-family:monospace;padding-right:1.5em;
 
  |col1style=font-family:monospace;padding-right:1.5em;
 
  |col2style=padding-right:2.5em; |col3style=text-align:center;
 
  |col2style=padding-right:2.5em; |col3style=text-align:center;
  |row1style=font-size:110%;font-weight:bold;| | Use / description | Default
+
  |row1style=font-size:110%;font-weight:bold;| | Use / description | Default value
  
  | {{{1}}}  | font color       | default
+
  | {{{1}}}  | ''text color''    | inherited
  | {{{2}}}  | text            |  
+
  | {{{2}}}  | ''text''             |  
  | link      | page link        |  
+
  | link      | {{=}}yes or {{=}}''fullpagename'' |  
 
}}
 
}}
  
Line 31: Line 48:
 
  |col1style=font-family:monospace;padding-right:1.5em;
 
  |col1style=font-family:monospace;padding-right:1.5em;
 
  |col2style=padding-right:2.5em; |col3style=text-align:center;
 
  |col2style=padding-right:2.5em; |col3style=text-align:center;
  |row1style=font-size:110%;font-weight:bold;| | Use / description | Default
+
  |row1style=font-size:110%;font-weight:bold;| | Use / description | Default value
  
  | {{{1}}}  | font color      | default
+
  | {{{1}}}  | ''text color''       | inherited
  | {{{2}}}  | background color | default
+
  | {{{2}}}  | ''background color'' | inherited
  | {{{3}}}  | text             |  
+
  | {{{3}}}  | ''text'' |
  | link      | page link        |  
+
  | link      | {{=}}yes or {{=}}''fullpagename''  |  
 
}}
 
}}
  
 
+
== Examples ==
{{tlx|font color|<text color>|<background color>|<text>}}
 
 
 
=== Examples ===
 
  
 
{|class=wikitable
 
{|class=wikitable
Line 57: Line 71:
 
|{{font color|white|black|white with black background}}
 
|{{font color|white|black|white with black background}}
 
|-
 
|-
|<code><nowiki>{{font color||yellow|default text in yellow background}}</nowiki></code>
+
||<code>{<nowiki/>{font color'''{{big|{{!}}<nowiki/>{{!}}}}'''yellow|default text in yellow background}}</code>
 
|{{font color||yellow|default text in yellow background}}
 
|{{font color||yellow|default text in yellow background}}
 +
|-
 +
||<code>{<nowiki/>{font color'''{{big|{{!}}}}'''bg=yellow|text=default text in yellow background}}</code>
 +
|{{font color|bg=yellow|text=default text in yellow background}}
 +
 
|}
 
|}
  
Line 70: Line 88:
 
|{{font color|white|blue|Wikipedia:Example|link=yes}}
 
|{{font color|white|blue|Wikipedia:Example|link=yes}}
 
|-
 
|-
|<code><nowiki>{{font color|white|blue|Wikipedia:Example|link=Wikipedia:Sandbox}}</nowiki></code>
+
|<code><nowiki>{{font color|white|blue|Example|link=Wikipedia:Sandbox}}</nowiki></code>
 
|{{font color|white|blue|Example|link=Wikipedia:Sandbox}}
 
|{{font color|white|blue|Example|link=Wikipedia:Sandbox}}
 +
|-
 +
|<code><nowiki>{{font color|text=Example|link=Wikipedia:Sandbox|bg=blue|fg=white}}</nowiki></code>
 +
|{{font color|text=Example|link=Wikipedia:Sandbox|bg=blue|fg=white}}
 
|}
 
|}
  

Revision as of 22:49, 25 November 2015

Purpose

Font color keeps your article up to date with the latest Wikipedia:HTML5 recommendations.

It inserts the span tag attributes

style=background-color:
style=color:

for you so your page increases its readability and usability in the wikitext and its rendering.

Usage

Usage

{{Font color}} has two forms:

{{font color|color|text}}
{{font color|text color|background color|text}}.

Either form has a |link= option for wikilinking the colorized 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.)

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|white|black|white with black background}} white with black background
{{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

The |link= parameter is useful where a link is placed in a colored header such as a navbox. For example, if the header was blue, you would leave the background color blank and set the font color to white. |link=yes sets the link to the text, otherwise it is set to the value of |link=.

Markup Renders as
{{font color|white|blue|Wikipedia:Example|link=yes}} Wikipedia:Example
{{font color|white|blue|Example|link=Wikipedia:Sandbox}} Example
{{font color|text=Example|link=Wikipedia:Sandbox|bg=blue|fg=white}} Example

See also