Teamplaid:Colors/documentation

Adhbhar - Purpose

{{ Colors}} 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.

{{ Colors}} 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 {{ Colors}} 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.

Ùsaid - Usage

{{Colors}} has a one-color and a two-color form:

{{Colors | color | text}}

{{Colors | 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.

{{Colors | fg=color | text=text}}

{{Colors | 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.

.{text with four words. → .text with four words.

. {text with four words . → . text with four words .

. {text with four words . → . text with four words .

Paramadairean - 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

Eisimpleirean - Examples

Markup	Renders as
{{Colors | green | green text}}	green text
{{Colors | blue | do not style text as a link}}	do not style text as a link
{{ Colors || yellow | default text in yellow background}}	default text in yellow background
{{ Colors | bg=yellow | text = default text in yellow background}}	default text in yellow background
{{Colors | white | black | white with black background}}	white with black background
{{Colors | #ffffff | #000000 | white with black background}} ({{enUici|hexadecimal colors}})	white with black background (hexadecimal colors)

Markup	Renders as
{{Colors | white | blue | Wikipedia:Example | link = yes}}	Wikipedia:Example
{{Colors | white | blue | Wikipedia:Example | link = :en:Wikipedia:Sandbox}}	Wikipedia:Example
{{Colors | 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 Colors (or other template or markup):

[[Wikipedia:Example|{{Colors|white|blue|the Wikipedia:Example page}}]]

→ the Wikipedia:Example page (a font-colored link),

a Colors does not accept a wikilink, it creates wikilinks itself with |link=.

• Teamplaid:OK {{ Colors | green | violet | Wikipedia:Example | link=yes}} → Wikipedia:Example (a |link= {{ Colors}})
• N{{ Colors | green | violet | the [[Wikipedia:Example]] page}} → the Wikipedia:Example page (Text with [[wikilink brackets]] overrides the designated color)
• N{{ Colors | 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

• Teamplaid:Sl.
• Teamplaid:Template usage.
• Teamplaid:Sl showing its use in articles whose title begins with the letter "F".

Faic cuideachd - Also see

• Important Manual of Style information
• Web colors
• HTML color names
• List of colors
• Help: Link color
• Category:Text color templates
• {{color}}
• {{background color}}
• {{color contrast ratio}}
• {{hilite}}
• {{font}}
• {{tq}}
• {{xt}}