Template:Tincture/doc
Uses Lua: |
This template uses TemplateStyles: |
This template is used to display vexillological and heraldic colors, as used in flags and coats of arms.
Usage
{{Tincture |1= }}
This template can handle any mixture of the whole tincture names and their single-letter abbreviation codes.
The colors are provided each one with unnamed parameters, or all of them in the first unnamed parameter, separated by slashes.
The color sequence should be: first silver and gold, then the other color letters in alphabetic order. Usage: e.g. {{ Tincture | a | b | g | v }} or {{ Tincture | argent | azure | gules | vert }}, or {{ Tincture | a/b/g/v }} or {{ Tincture | argent/azure/gules/vert }}.
Only the slash-separated format can be used from {{COAInformation}} and {{File generation description}} e.g. |Tincture=a/b/g/v
, and from {{Image generation}} |C=a/b/g/v
.
Note: An empty parameter (e.g. 2 pipes or slashes) terminates the generation of the boxes and leaves the trailer an internal comment.
Template parameters
Parameter | Description | Default | Status | |
---|---|---|---|---|
1 | color 1 | The first color to display, or all colors separated by / (slashes). | empty | required |
2 | color 2 | The second color to display, and so on, any number of colors | empty | optional |
ss | color shade | The color style to be used. Several special color shades are supported. | 0 | optional |
cm | comment | Any text that should follow the boxes. | empty | optional |
pf | postfix | possible postfixing of each box, e.g. <br /> for vertical, or pipe(s) for table elements. | empty | optional |
align | alignment | The alignment of the color boxes: “left”, “right” or “center”. | left | optional |
+ | Information field | “+” sign instead of a color code, or if the value is “+” (i.e. “|+=+”), the output is wrapped in {{Information field}}. | empty | optional |
- | cat suppression | “-” sign instead of a color code: avoids the (automatic or other) categorization to Coats of arms by tincture. | empty | optional |
ns | namespace | “6” for treating files; not needed for COAInformation. | empty | optional |
cat | categories | Override standard categorization. More details on categorization. | empty | optional |
Additional information
The template is intended to be used in the following namespaces: no namespace specified
The template is intended to be used by the following user groups: no user group specified
Example
{{Tincture|a / o / b / g / p / s / v}}
renders as:
See also
Colors
Each one of these colors can be specified by a one-letter short code (e.g. "A"), or by its standardized name (e.g. "argent-d").
Tooltip: The hexadecimal rgb color value is displayed when the cursor is moved over the colored field.
argent
|
a | argent
|
|
argent-d
|
A | argent-d
|
[“argent dark”] |
or
|
o | or
| |
azure
|
b | azure
|
[for “bleu” or “blue”] |
céleste
|
B | céleste
|
[for “bleu-céleste”] |
carnation
|
c | carnation
| |
cendrée
|
C | cendrée
| |
gules
|
g | gules
| |
naranja
|
n | naranja
| |
purpure
|
p | purpure
| |
sable
|
s | sable
| |
tenné
|
t | tenné
| |
vert
|
v | vert
| |
transparent
|
x | invisible
|
[no tincture] (transparent) |
Other common tinctures like orange, sanguine, murrey, brunâtre are not yet supported.
But for test reasons it is also possible to use it with additional colors, instead of the color letter the hexadecimal color value can be used, e.g.
#abc
|
#abc | (note that the short color codes with 3 hex-digits was not working with the now obsolete Internet Explorer web browser!) |
#2F4D5A. | In the cases of hex color codes the parameter for text color, e.g. tc=F0F , allows to use a text color more different from the background color.
|
Any other parameter value causes maintenance categorization and an error message, e.g {{ Tincture | 32a }} gives the error message
- Note :
- The tincture nomination should always be: first
argent
andor
, then all the other colors in alphabetic sequence: - a - A - o — b - B - c - C - g - n - p - s - t - v
Special color shades (palettes)
- With {{COAInformation}}, use
|tincture-ss=
or|ss=
as an addition to|tincture=
, e.g.|tincture=a/b/g|ss=NW
. - With {{File generation description}} use
|Tincture-ss=
, and with {{Image generation}} the parameter|ss=
or|Css=
. - In stand-alone usage, add the "ss" parameter: {{ Tincture | a | b | g | NW }}. In some shades, not all colors are defined.
In the stand-alone case it is also possible to define the special color shade with e.g. {{ Tincture | a | b | g | ss = NW }}, or shorter
with {{ Tincture | a/b/g/NW }} (code for the special color shade in upper case!), like a color code or the +
or -
at any position.
- With the parameter
ss=GN
(or the parameterss=0
) (with the parameterss=≈
it can be shown that the used colours do not match exactly the standard tinctures) or without this parameter, the generic tincture colors are shown: Tincture (GN)argentargent-dorazurecélestecarnationcendréegulesnaranjapurpuresabletennévert
- With the parameter
ss=FR
the tincture colors of France are shown: Tincture (FR)argenttransparentorazurecélestecarnationcendréegulesnaranjapurpuresabletransparentvert
- With the parameter
ss=BW
the tincture colors of Baden-Württemberg are shown: Tincture (BW)argenttransparentorazuretransparentcarnationtransparentgulestransparenttransparentsabletransparentvert
- With the parameter
ss=BY
the slightly different Bavarian colors are shown: Tincture (BY)argentargent-dorazurecélestecarnationcendréegulestransparentpurpuresabletennévert
- With the parameter
ss=RP
the slightly different Rhineland-Palatinate colors are shown: Tincture (RP)argentargent-dorazurecélestecarnationcendréegulestransparentpurpuresabletennévert
- With the parameter
ss=BB
the tincture colors of Brandenburg are shown: Tincture (BB)argenttransparentorazurecélestetransparenttransparentgulestransparenttransparentsabletransparentvert
- With the parameter
ss=CH
the tincture colors of Switzerland are shown: Tincture (CH)argenttransparentorazureazuretransparenttransparentgulestransparenttransparentsabletransparentvert with "light azure"
- With the parameter
ss=SF
the tincture colors of the Swiss flags reglement are shown: Tincture (SF)argenttransparentorazuretransparenttransparenttransparentgulestransparenttransparentsabletransparentvert
- With the parameter
ss=AG
the tincture colors of Kanton Aargau are shown: Tincture (AG)argenttransparentorazuretransparenttransparenttransparentgulestransparenttransparentsabletennévert
- With the parameter
ss=GR
the tincture colors of Kanton Graubünden are shown: Tincture (GR)argenttransparentorazuretransparenttransparenttransparentgulestransparentpurpuresabletennévert
- With the parameter
ss=NW
the tincture colors of Kanton Nidwalden are shown: Tincture (NW)argenttransparentorazuretransparenttransparenttransparentgulestransparenttransparentsabletennévert
- With the parameter
ss=UA
the tincture colors of Upper Austria are shown: Tincture (UA)argenttransparentorazuretransparentcarnationcendréegulestransparenttransparentsabletennévert
- With the parameter
ss=HU
the tincture colors of Hungary are shown: Tincture (HU)argentargent-dorazuretransparenttransparenttransparentgulestransparentpurpuresabletransparentvert
- With the parameter
ss=IT
the tincture colors of Italy are shown: Tincture (IT)argentoargento-doroazzurrocielocarnagioneincolorerossoincoloreporporaneroincoloreverde
- With the parameter
ss=RU
the tincture colors of Russia are shown: Tincture (RU)argenttransparentorazuretransparenttransparentcendréegulesnaranjapurpuresabletennévert
- With the parameter
ss=SK
the tincture colors of Slovakia are shown: Tincture (SK)argenttransparentorazuretransparenttransparenttransparentgulestransparenttransparentsabletransparentvert
- With the parameter
ss=SV
the tincture colors of Sweden are shown: Tincture (SV)argenttransparentorazurecélestecarnationtransparentgulestransparentpurpuresabletransparentvert
- With the parameter
ss=NS
("NS" for "non standard") all other colors can be mentioned (not shown): Tincture (NS)argentargent-dorazurecélestecarnationcendréegulesnaranjapurpuresabletennévert
See also Template talk:Tincture/box or Commons talk:All tincture variations for another illustration.
When a color combination contains a color that cannot be expressed with above tinctures, with ColorString such colors can be shown:
- {{ ColorString | /B/#069/#396/#900/#333/#666/#999 }} will give:
#069#396#900#333#666#999, - {{ ColorString | /D/#069/wmb/#396/#396 /#900/wmr/wm3/#333 }} will give:
wmb#396wmr#333.
- {{ Tincture | brunâtre/murrey/sanguine }} will give brunâtremurreysanguine
- {{ Tincture | e/V/m }} will give
Categorization
- Automatic categorization is performed by the subtemplates {{Tincture/cat0}}.
- Any other (tincture-) category or categories may be defined with the parameter
cat=
; specified either complete with the brackets:cat=[[Category:...]]
or only the name (without brackets and "Category:").
While colours may be expressed by codes or by full names, automatic categorization is only possible when the one-letter-codes are used.
- To suppress any categorizing set either “
cat=
”, “cat=-
” or set the “-
” withSS=
or like a color code, at any position. - To put into Tinctures uncategorizeable, use "
?
" like a color code, at any position. - To force categorization "
*
" can be used like a color code, at any position. - Otherwise automatic categorization occurs, when possible.
Precedence
When contradicting parameters are set:
- The "-" (don't categorize) suppresses every categorization
- The "?" (categories unable) ignores the "force cat" parameter
- The "*" (force categorization) categorizes otherwise,
- The automatic categorization may occur when no other parameter is used.
Information field
An internationalized field name
is generated, when required by specifying “+=+
”;
- when tinctures are set with COAInformation, this is done by default;
- when tinctures are set with Image generation, this is done by default (but can be suppressed with “
Cf=-
”). - The “+” for the field name can also be set as simple “
+
” like the “-
” like a color code, at any position.
- See also Color boxes.
GPL palettes
Image editing applications such as Inkscape and GIMP support image swatch files known as GIMP-Palettes, which can be imported to and exported from these applications.
The Commons:Colour palettes can be used to create copy&paste-able data from all the tincture variations shown above, and to have these valid colours for usage wihin the tools.
A complete instruction how to generate such palettes can be found in Commons talk:Colour palettes.
To use the template:Tincture for table creation, the parameter |gpltab=
can be used:
gpltab=1
default value, is automatically set to tincturize filesgpltab=2
value to generate tablesgpltab=3
value to do both, is automatically set on that page
Because this parameter needs never to be set, except for test cases, it is not described above.
A complete set of instructions on how to generate such palettes can be found in Commons talk:Colour palettes; it contains also some hints how to add new colour variations.