Template:Outline color/doc

Description

This template displays text with a colored outline. It's basic use is thus: {{outline color|This text is outlined in gold}}, which comes out as: This text is outlined in gold

Other colors can be specified but the default is a gold 2px solid outline with no blending. An optional strength parameter also allows customised blending at three strength levels.

Usage

{{outline color|text}}

or

{{outline color|text|color}}

or

{{outline color|text|color|strength=1..3}}

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Outline color in articles based on its TemplateData.

TemplateData for Outline color

<templatedata>{

 "description": "Displays text with a colored outline.",
 "params": {
   "1": {
     "label": "Text",
     "description": "The string to be outlined.",
     "type": "string",
     "required": true
   },
   "2": {
     "label": "Color",
     "description": "The outline color. Can be specified as a named web color or the standard 6-digit or 3-digit hexadecimal codes. If this parameter is not specified a default value of #FFD700 is used which is gold.",
     "type": "string",
     "default": "#FFD700",
     "required": false
   },
   "3": {
     "label": "Strength",
     "description": "An optional parameter that in the range 1..3 allows the outline to be blended at customised strength levels. A value of 0 produces no outline. If this parameter is any other value, or is not specified, then the default option is a solid 2px outline with no blending which produces a strong outline",
     "type": "string",
     "required": false
   }
 }

}</templatedata>

Usage

Examples ranging from solid 2px outline to no outline:

• {{Outline color|Outline in default color}}
  → Outline in default color
• {{Outline color|Outline in #FF69B4|#FF69B4}}
  → Outline in #FF69B4
• {{Outline color|Outline in red|red}}
  → Outline in red
• {{Outline color|Outline in red|red|strength=3}}
  → Outline in red
• {{Outline color|Outline in red|red|strength=2}}
  → Outline in red
• {{Outline color|Outline in red|red|strength=1}}
  → Outline in red
• {{Outline color|Outline in red|red|strength=0}}
  → Outline in red

Example showing outlining of bolded wikilink:

• {{Outline color|'''[[ACT and Southern NSW Rugby Union]]'''|gold}}
  → ACT and Southern NSW Rugby Union

Example showing outlining of bolded wikilink with colored text:

• [[Waikato Chiefs|<span style= "color:#ff0;">{{Outline color|'''Chiefs'''|red|strength=3}}</span>]]
  → Chiefs

See also

• Template:Swatch inline — displays text with a background in a solid color