Jump to content

Template:Colort/Color/doc

From Wikipedia, the free encyclopedia

Color table row, for use with {{Colort}}, which creates the column headings.

Usage

[edit]

{{Colort/Color

|name=common name – may contain markup
|alias=alternative name or |html_name=html name
|sort=sort name – an alternative name or spelling that should be used for sorting, must not contain markup
|r=red decimal value – 0–255, percent values are automatically generated
|g=green decimal value – 0–255, percent values are automatically generated
|b=blue decimal value – 0–255, percent values are automatically generated
|hex=hex triplet – can be automatically generated
|h=hue degrees – HSV/HSB and HSL, can be automatically generated
|s=saturation percent – HSV/HSB, can be automatically generated
|v=brightness/value percent – HSV/HSB, can be automatically generated
|sat=saturation percent – HSL, can be automatically generated
|l=lightness percent – HSL, can be automatically generated

}}

Blank template, for copy-pasting
{{Colort/Color
 |name  = 
 |alias = 
 |sort  = 
 |r     = 
 |g     = 
 |b     = 
 |hex   = 
 |h     = 
 |s     = 
 |v     = 
 |sat   = 
 |l     = 
}} 

If not provided, values for HSL, HSV and hex triplet are auto-generated from RGB parameters. That means, parameters name, r, g and b are required, the rest is optional and mostly should only be used if the automatic calculation yields rounding errors or fails for other reasons.

The hash sign # for hex triplets, percent % and degree ° symbols must not be entered as they are included automatically.

Parameters

[edit]
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Colort/Color in articles based on its TemplateData.

TemplateData for Colort/Color

Table row with digital color data, usually in 11 or 12 columns.

Template parameters

ParameterDescriptionTypeStatus
common namename

the vulgar color name, may contain markup

Linerequired
alternative namealias html_name

usually used for synonymous names, but may be used for arbitrary content if the last column header is changed

Lineoptional
(deprecated)html_name

legacy variant of alias parameter, kept for backwards compatibility only

Linedeprecated
sort namesort

an alternative name or spelling that should be used for sorting, must not contain markup like links

Lineoptional
code namecode

the color name as used in computer code (e.g. special capitalization or spelling with hyphens, underscores or spaces), must not contain markup

Lineoptional
color articlelink

the Wikipedia article title explaining this color, must not contain markup

Page nameoptional
red component (RGB)r

decimal 8bit value (0–255), percent value is generated automatically

Default
0
Numberrequired
green component (RGB)g

decimal 8bit value (0–255), percent value is generated automatically

Default
0
Numberrequired
blue component (RGB)b

decimal 8bit value (0–255), percent value is generated automatically

Default
0
Numberrequired
hex triplet (RGB)hex

six hexadecimal digits, automatically preceded by a hash sign (#) as used in several computer languages, e.g. CSS

Default
generated from r, g, b
Lineoptional
hue (HSB/HSV, HSL)h

in degrees (0–359), automatically succeeded by degrees sign (°)

Default
generated from r, g, b
Numberoptional
saturation (HSB/HSV)s

percentage (0–100), automatically succeeded by percent sign (%), usually differs from HSL saturation

Default
generated from r, g, b
Numberoptional
brightness/value (HSB/HSV)v

percentage (0–100), automatically succeeded by percent sign

Default
generated from r, g, b
Numberoptional
saturation (HSL)sat

percentage (0–100), automatically succeeded by percent sign (%), usually differs from HSV/HSB saturation

Default
generated from r, g, b
Numberoptional
lightness/luminance (HSL)l

percentage (0–100), automatically succeeded by percent sign (%)

Default
generated from r, g, b
Numberoptional
narrow layout switchnarrow

if specified this parameters changes the layout to a narrower one that covers two rows, must be specified for all neighboring rows too

Lineoptional
extra right paddingpadding

a valid CSS length value, usually set appropriately to care for sort buttons in column headers, should be specified for all neighboring rows too

Default
21px (0 if narrow)
Lineoptional
color sample column widthwidth

a valid CSS length value setting the width of the first column, should be specified for all neighboring rows too

Default
4em (1em if narrow)
Lineoptional
border colorborder

a valid CSS color value or name for the color of cell borders, usually a light gray

Default
#AAA
Lineoptional
TOC anchorlink target

provides a link target, especially for links from the table of contents, should usually be specified only for the first color name starting with a certain letter in an alphabetically sorted list, to said letter, uppercase

Lineoptional

Copy and Paste

[edit]
{{Colort/Color|name=|r=|g=|b=}}
{{Colort/Color|name=|alias=|sort=|r=|g=|b=}}
{{Colort/Color|name=|alias=|sort=|r=|g=|b=|hex=|h=|sat=|l=|s=|v=}}

Examples

[edit]

See X11 color names, Web colors, or "what links here".

Code

[edit]

The {{colort/Color}} template provides the calculation of missing values, the actual table row design is found in {{colort/1row}}. This sub-template should never be used directly elsewhere!