Template:CategoryBgColor/doc: Difference between revisions
m (Reason for Pastel 2) |
m (1 revision imported: initial setup) |
(No difference)
|
Latest revision as of 09:25, 25 August 2024
This is a documentation subpage for Template:CategoryBgColor. It contains usage information, categories and other content that is not part of the original Template page. |
This template implements an accessible color scheme for text backgrounds based on a light Brewer palette called Pastel 2. The generated color code is used in {{CellCategory }} and can be used as a parameter for legends, boxes and others. Original colors were lightened slightly to achieve WCAG AA with text and links (including inline citations) and may be revised when Wikipedia's default style changes. The order was also changed to promote the pairs least modified by lightening. Pastel 2 was chosen because it is the Brewer palette that requires the least modifications to achieve this accessibility goal.
As a qualitative/categorical palette, these colors should not be used with any specific meaning related to preference (good or bad) or magnitude (intensity, frequency, etc.), and may change in the future, maintaining only the property of serving to differentiate between categories. For comparison tables, see table cell templates associated with specific meanings.
Although the WCAG level guarantees the readability of the text, the lightness is about the same in all the colors produced, not following color universal design and, therefore, impacting some colorblind readers. Unfortunately, the only solution to this is to reduce lightness below WCAG AA levels for some colors, decreasing accessibility for many people. Therefore, if the category is important, it should also be represented as text in the article, not just as color.
The palette provides these colors for 8 categories:
1 2 3 4 5 6 7 8
Usage example
Wikitext:
{{Legend inline |#{{CategoryBgColor|1}} |Category 1}}
{{Legend inline |#{{CategoryBgColor|2}} |Category 2}}
{{Legend inline |#{{CategoryBgColor|3}} |Category 3}}
...
|{{CellCategory|1|Info on category 1}}
|-
|{{CellCategory|3|Info on category 3}}
|-
|{{CellCategory|2|Info on category 2}}
...
Result:
Category 1 Category 2 Category 3
Info on category 1 |
Info on category 3 |
Info on category 2 |
Code
TemplateData
This is the TemplateData documentation for this template used by VisualEditor and other tools.
CategoryBgColor
A template for an accessible qualitative palette.
Parameter | Description | Type | Status | |
---|---|---|---|---|
category | 1 | category index
| Number | suggested |
See also