Template:Color/doc: Difference between revisions

Latest revision as of 23:57, 11 July 2025

Note: This template is used on a great lot of pages. In order not to put too much load on the servers, edits should be kept to a bare minimum. Please discuss proposed changes on the talk page first.

Editing a template causes all pages that use the template to be re-rendered. If the template is used often, this can put a lot of load on the servers since it fills up the job queue.
Keep in mind that templates that are used on file description pages also show up on other wikis.

Uses Lua:

Module:String

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Color.

العربية ∙ asturianu ∙ Boarisch ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ català ∙ čeština ∙ dansk ∙ Deutsch ∙ Zazaki ∙ Ελληνικά ∙ English ∙ Esperanto ∙ español ∙ eesti ∙ euskara ∙ فارسی ∙ suomi ∙ français ∙ galego ∙ עברית ∙ हिन्दी ∙ hrvatski ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ кыргызча ∙ Lëtzebuergesch ∙ македонски ∙ മലയാളം ∙ ဘာသာမန် ∙ Bahasa Melayu ∙ Mirandés ∙ မြန်မာဘာသာ ∙ norsk bokmål ∙ Plattdüütsch ∙ Nederlands ∙ norsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ Scots ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Türkçe ∙ українська ∙ اردو ∙ oʻzbekcha / ўзбекча ∙ Tiếng Việt ∙ 中文 ∙ 中文（简体） ∙ 中文（繁體） ∙ 中文（臺灣） ∙ +/−

coloring of text,
drawing boxes,
tooltipping

Usage

Template parameters

Parameter	Description	Default	Status
`1`	color of the text, in any valid notation, plus "b" as a short form for "black" (#000000) "w" as a short form for "white" (#FFFFFF)	red	optional
`2`	text, in any wiki notation	empty	required
`bg` 3	color of the background, in any valid notation: CSS color name, #RGB, ~~tincture name~~	transparent	optional
`title` 4	any text to be tooltipped	"bg" value	optional
`style or css` 5	additional CSS style attributes, as e.g. border and padding	empty	optional
`b` or `bold` 6	specification of font-weight: normal/bold (lighter/bolder) or numeric value 100...900 where normal=400 and bold=700¹	normal 0400	optional

Additional information

The template is intended to be used in the following namespaces: all namespaces

The template is intended to be used by the following user groups: all users

Localization

This template is not intended to be localized.

Usage: {{Color|color|text}}

Examples:

{{color|red|example text}} → example text
{{color|#00F|example text}} → example text
{{color|white|example text|bg=black}} → example text
{{color|#000|box ''without'' tooltip|css=border:1px solid #7F7|title=}} → box without tooltip

Short forms:

{{color||default color|bg=cyan}} → default color
{{color|b|black color|bg=gold}} → black color
{{color|w|white color|bg=purple}} → white color
{{color|b|{{0}}#FBBD46{{0}}|bg=#FBBD46}} → 0#FBBD460

To draw just a color box with bg-color, use it like

{{Color|1=#F0F|2=XX|bg=#F0F}} → XX or {{Color||{{0|00}}|bg=#0a0}} → 00 or the shortest form {{Cbox|#CCC}} → 00

To just tooltip a text, use it like
The <u>{{color|#000|underlined text|title=tooltip example}}</u> is ''{{W|tooltip}}ped'' : 0 The underlined text is tooltipped.

It is also possible to define additional CSS data, e.g.
{{color|b|'''padded box'''|bg=#CFC|css=border:2px dotted #F80;padding:0 8px|title=CSS example}} → padded box

For colors see: Web colors. Three-digit hexadecimal color tables are shown there.

The bg-color is tooltipped — move the cursor to the field to see

Font-weight

can be specified either with

6 = b sets a font-weight of bold (graduation 700)
6 = bold sets a font-weight of bold (graduation 900)

or with the keyword (parameter name) "b" or "bold"

b = any of the parameter values normal, bold, lighter, bolder, 100, 200, ... 900

The specifications 6=b, b=bold, bold=bold, b=700, bold=700 are equivalent;
it can as well be specified with style=font-weigth:bold or css=font-weight:700.

@@ Line 1: / Line 1: @@
+{{Heavily used template|3=+}}{{Lua|Module:String}}
 {{TemplateBox
 |1    =
-|1d-en= color of the text, in any valid notation, plus<br>"'''b'''" as a short form for "black" (#000000)<br>"'''w'''" as a short form for "white" (#FFFFFF)
+|1d-en= color of the text, in any valid notation, plus<br />"'''b'''" as a short form for "black" (#000000)<br />"'''w'''" as a short form for "white" (#FFFFFF)
 |1def = {{color||red}}
 |1stat= optional-
@@ Line 10: / Line 11: @@
 |3    = bg
-|3d-en= color of the background, in any valid notation
+|3aliases=3
+|3d-en= color of the background, in any valid notation:<br />CSS color name, #RGB, <s>tincture name</s>
 |3def = transparent
 |3stat= optional-
 |4    = title
+|4aliases=4
 |4d-en= any text to be tooltipped
 |4def = "bg" value
 |4stat= optional-
-|5    = css
+|5    = style or css
-|5d-en= additional CSS attributes
+|5aliases=5
-|5stat= optional-
+|5d-en= additional ''CSS style'' attributes, as e.g. {{C|Valid SVG created with Inkscape:Silk slips|border}} and {{C|Valid SVG created with Inkscape:Kangxi radicals|padding}}
+|6    = b</code> or <code>bold
+|6aliases=6
+|6d-en= specification of font-weight: normal/bold (lighter/bolder)<br />or numeric value 100...900 where normal=400 and bold=700[[#Font-weight|{{exp|1}}]]
+|6def = normal<br />{{0}}400
+|6stat= optional-
   |name = {{BASEPAGENAME}}
@@ Line 30: / Line 39: @@
   |usergroup = all
   |placement = <!--inline-->
+|seealso =
+* {{tl|Tincture}}
+* {{Tl|Cbox}}
+* {{Tl|ColorRect}}
+|i18n-method=-
 }}
 ----
-'''Usage:''' <nowiki>{{</nowiki>color|''color''|''text''}}
+'''Usage:''' <nowiki>{{</nowiki>Color|''color''|''text''}}
 '''Examples:'''
@@ Line 41: / Line 55: @@
 * <nowiki>{{color|#000|box ''without'' tooltip|css=border:1px solid #7F7|title=}}</nowiki> → {{color|#000|box ''without'' tooltip|css=border:1px solid #7F7|title=}}
-'''Short formes:'''
+'''Short forms:'''
 * <nowiki>{{</nowiki>color||default color|bg=cyan}} → {{color||default color|bg=cyan}}
 * <nowiki>{{</nowiki>color|b|black color|bg=gold}} → {{color|b|black color|bg=gold}}
 * <nowiki>{{</nowiki>color|w|white color|bg=purple}} → {{color|w|white color|bg=purple}}
+* <nowiki>{{color|b|{{0}}#FBBD46{{0}}|bg=#FBBD46}}</nowiki> → {{color|b|{{0}}#FBBD46{{0}}|bg=#FBBD46}}
+To draw just a ''color '''box''''' with ''bg''-color, use it like
-To draw just a ''color '''box''''' with ''bg''-color use it like
+* <nowiki>{{</nowiki>Color|1=#F0F|2=XX|bg=#F0F}} → {{color|1=#F0F|2=XX|bg=#F0F}} &ensp; or &ensp; <nowiki>{{</nowiki>Color||<nowiki>{{</nowiki>0|00}}|bg=#0a0}} → {{color||{{0|00}}|bg=#0a0}} &ensp; or &ensp; the ''shortest form'' {{Tlx|Cbox|#CCC}} → {{cbox|#CCC}}
-* <nowiki>{{</nowiki>Color||<nowiki>{{</nowiki>0|00}}|bg=#0a0}} → {{color||{{0|00}}|bg=#0a0}} &ensp; or &ensp; <nowiki>{{</nowiki>Color|1=#F0F|2=XX|bg=#F0F}} → {{color|1=#F0F|2=XX|bg=#F0F}} &ensp; or &ensp; {{Tlx|Cbox|#CCC}} → {{cbox|#ccc}}
-To just '''''tooltip''''' a text use it like<br>
+To just '''''tooltip''''' a text, use it like<br />
 <nowiki>The <u>{{color|#000|underlined text|title=tooltip example}}</u> is ''{{W|tooltip}}ped'' </nowiki>: {{0}} The <u>{{color|#000|underlined text|title=tooltip example}}</u> is ''{{W|tooltip}}ped''.
-It is also possible to define ''additional CSS data'', e.g.<br>
+It is also possible to define ''additional CSS data'', e.g.<br />
-<nowiki>{{color|b|'''padded box'''|bg=#CFC|</nowiki>'''css='''border:2px dotted #F80;padding:0 8px|'''title'''=CSS example}} → {{color|b|'''padded box'''|bg=#CFC|css=border:2px dotted #F80;padding:0 8px|title=CSS example}}
+<nowiki>{{color|b|'''padded box'''|bg=#CFC|</nowiki>'''css='''<code>border:</code>2px dotted #F80;<code>padding:</code>0 8px|'''title'''=CSS example}} → {{color|b|'''padded box'''|bg=#CFC|css=border:2px dotted #F80;padding:0 8px|title=CSS example}}
@@ Line 62: / Line 76: @@
 The {{color|black|''bg''-color|title=background-color-tooltipping}} is {{W|Tooltip|''tooltipped''}} — move the cursor to the field to see
+== Font-weight ==
+can be specified either with
+* 6 = b ''sets a font-weight of bold (graduation 700)''<br />6 = bold ''sets a font-weight of bold (graduation 900)''
+'''''or''''' with the keyword (parameter name) "b" or "bold"
+* b = ''any of the parameter values normal, bold, lighter, bolder, 100, 200, ... 900''
+The specifications <code>6=b</code>, <code>b=bold</code>, <code>bold=bold</code>, <code>b=700</code>, <code>bold=700</code> are equivalent;<br />it can as well be specified with <code>style=font-weigth:bold</code> or <code>css=font-weight:700</code>.
 <includeonly>
-[[af:Sjabloon:Kleur]]
+[[Category:Colorbox formatting templates| ]]
-[[ar:قالب:لون]]
-[[da:Skabelon:Color]]
-[[de:Vorlage:Farbindex]]
-[[en:Template:Color]]
-[[fr:Modèle:Coloré]]
-[[ja:Template:Color]]
-[[nl:Sjabloon:Tekstkleur]]
-[[no:Mal:Farve]]
-[[pl:Szablon:Kolor]]
-[[pt:Predefinição:Color]]
-[[ro:Format:Color]]
-[[ru:Шаблон:Color]]
-[[sl:Predloga:Barva]]
-[[uk:Шаблон:Кольоровий текст]]
-[[zh-yue:Template:Color]]
 [[Category:Color text formatting templates| ]]
 <includeonly>