Module:Color contrast/doc: Difference between revisions
Added the page to Category:Module documentation pages |
m 1 revision imported |
(No difference)
| |
Latest revision as of 22:36, 21 December 2024
{{#switch:
{{#if:
|
| {{#ifeq:Module|Module
| module
| other
}}
}}
| module =
{{#switch: protected
| pre-alpha | prealpha | pa = File:OOjs UI icon text-style.svg | alpha | a = File:OOjs UI icon bold-a.svg | beta | b = File:OOjs UI icon bold-b.svg | release | r | general | g = File:OOjs UI icon check-constructive.svg | protected | protect | p = [[File:{{#if:|Cascade-protection-shackle.svg|{{#ifeq:|sysop|Full-protection-shackle-red.svg|Semi-protection-shackle-no-text.svg}}}}|40x40px|link=]] | semiprotected | semiprotect | semi = File:Semi-protection-shackle.svg | #default = File:OOjs UI icon alert-destructive.svg}} | {{#switch: protected
| pre-alpha | prealpha | pa = <translate> This module is rated as [[<tvar name=1>Special:MyLanguage/Category:Modules in pre-alpha development</tvar>|pre-alpha]].</translate> <translate> It is unfinished, and may or may not be in active development.</translate> <translate> It should not be used from article namespace pages.</translate> <translate> Modules remain pre-alpha until the original editor (or someone who takes one over if it is abandoned for some time) is satisfied with the basic structure.</translate>{{#ifexpr:
{{#ifexpr: (
{{#ifeq:doc|doc|1|0}} or ( {{#ifeq:{{#titleparts:module:color contrast/doc|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|0}} or {{#ifeq:doc|sandbox|1|0}} || {{#ifeq: | true | | }}
}}
| alpha | a = <translate> This module is rated as [[<tvar name=1>Special:MyLanguage/Category:Modules in alpha</tvar>|alpha]].</translate> <translate> It is ready for third party input, and may be used on a few pages to see if problems arise, but should be watched.</translate> <translate> Suggestions for new features or changes in their input and output mechanisms are welcome.</translate>{{#ifexpr:
{{#ifexpr: (
{{#ifeq:doc|doc|1|0}} or ( {{#ifeq:{{#titleparts:module:color contrast/doc|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|0}} or {{#ifeq:doc|sandbox|1|0}} || {{#ifeq: | true | | }}
}}
| beta | b = <translate> This module is rated as [[<tvar name=1>Special:MyLanguage/Category:Modules in beta</tvar>|beta]], and is ready for widespread use.</translate> <translate> It is still new and should be used with some caution to ensure the results are as expected.</translate>{{#ifexpr:
{{#ifexpr: (
{{#ifeq:doc|doc|1|0}} or ( {{#ifeq:{{#titleparts:module:color contrast/doc|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|0}} or {{#ifeq:doc|sandbox|1|0}} || {{#ifeq: | true | | }}
}}
| release | r | general | g = <translate> This module is rated as [[<tvar name=1>Special:MyLanguage/Category:Modules for general use</tvar>|ready for general use]].</translate> <translate> It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate.</translate> <translate> It is ready to mention on help pages and other resources as an option for new users to learn.</translate> <translate> To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.</translate>{{#ifexpr:
{{#ifexpr: (
{{#ifeq:doc|doc|1|0}} or ( {{#ifeq:{{#titleparts:module:color contrast/doc|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|0}} or {{#ifeq:doc|sandbox|1|0}} || {{#ifeq: | true | | }}
}}
| protected | protect | p = <translate> This module is [[<tvar name=1>Special:MyLanguage/Category:Modules subject to page protection</tvar>|subject to {{<tvar name=2>#if:</tvar>|cascading|page}} protection]].</translate> <translate> It is a highly visible module in use by a very large number of pages.</translate> <translate> Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is [[<tvar name=1>Special:MyLanguage/Project:Protected page</tvar>|protected]] from editing.</translate>{{#ifexpr:
{{#ifexpr: (
{{#ifeq:doc|doc|1|0}} or ( {{#ifeq:{{#titleparts:module:color contrast/doc|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|0}} or {{#ifeq:doc|sandbox|1|0}} || {{#ifeq: | true | | }}
}}
| #default = Template:Error
}} |
| other | #default = Template:Error }}
- REDIRECT Template:High-risk
| File:Lua-Logo.svg | This module depends on the following other modules: |
This module is used primarily by
- {{Color contrast ratio}}
- {{RGBColorToLum}}
- {{Color contrast conformance}}
- {{Ensure AAA contrast ratio}}
- {{Ensure AA contrast ratio}}
- {{Greater color contrast ratio}}
It is also used for tracking within
and for documentation in
The formulas used are stated in WCAG 2.x specifications. WCAG is the main guideline for creating accessible interfaces on the web.
Usage
To use this module, you may use one of the above listed templates or invoke the module directly
- To compute relative luminescence:
{{ColorToLum|color}}or{{#invoke:Color contrast|lum|color}} - To compute a contrast ratio between two colors:
{{Color contrast ratio|color1|color2|error=?}}or{{#invoke:Color contrast|ratio|color1|color2|error=?}} - To determine which of two colors (color2a and color2b) has the greater contrast ratio with a particular color (color1):
{{Greater color contrast ratio|color1|color2a|color2b}}or{{#invoke:Color contrast|greatercontrast|color1|color2a|color2b}} - To compute the contrast ratio between the background and text colors specified in a css style string:
{{#invoke:Color contrast|styleratio|css style statement string|default background color|default text color}}