Template:Color/doc: Difference between revisions

Template page
(32 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{doc/start}}
{{doc/start}}
<pre>
<pre>
This template is used to apply pre-defined colour/style classes to text.
<nowiki>{{color|X|Y|game=Z}}</nowiki> or <nowiki>{{clr|X|Y|game=Z}}</nowiki>
The first parameter is the color identifier code.
This template is used to apply color/style classes to text. Currently, it supports 8 pre-defined colors and 6 styles that are colorblind and "Dark mode" friendly, though the template can also be used for arbitrary HTML colors.
The second parameter is the text to be styled.
 
Colors applied with this template can be disabled or re-enabled through the use of "Monochrome mode" and "Colorful mode", so it is recommended to use this over applying text colors with style attribute, e.g. <span style="color: #ff0000;">Red text</span>.
 
The first parameter (X) is the color identifier code. The second parameter (Y) is the text to be styled.
Optionally, game name abbreviations (Z) can be used to force the colors of a specific game's buttons. If this is not provided, it will assume the game from the RootPageName of the current page, or if not found, default to Guilty Gear's button colors.
</pre>
</pre>
==Examples==
See [[Template:Clr/styles.css]] for an exhaustive list and the exact CSS used.
;<nowiki>{{clr|punch|5P}}</nowiki>
:{{clr|1|5P}}
;<nowiki>{{clr|2|2K}}</nowiki>
:{{clr|2|2K}}
;<nowiki>{{clr|3|c.S}}</nowiki>
:{{clr|3|c.S}}
;<nowiki>{{clr|4|j.H}}</nowiki>
:{{clr|4|j.H}}
;<nowiki>{{clr|5|j.D}}</nowiki>
:{{clr|5|j.D}}
;<nowiki>{{clr|6|Very Easy}}</nowiki>
:{{clr|6|Very Easy}}
;<nowiki>{{clr|7|Medium}}</nowiki>
:{{clr|7|Medium}}
;<nowiki>{{clr|8|Very Hard}}</nowiki>
:{{clr|8|Very Hard}}
;<nowiki>{{clr|added|added}}</nowiki>
:{{clr|added|added}}
;<nowiki>{{clr|new|new}}</nowiki>
:{{clr|new|new}}
;<nowiki>{{clr|removed|removed}}</nowiki>
:{{clr|removed|removed}}
;<nowiki>{{clr|reworked|reworked}}</nowiki>
:{{clr|reworked|reworked}}
;<nowiki>{{clr|buff|buff}}</nowiki>
:{{clr|buff|buff}}
;<nowiki>{{clr|nerf|nerf}}</nowiki>
:{{clr|nerf|nerf}}
;<nowiki>{{clr|9|5A}}</nowiki>
:{{clr|9|5A}}
;<nowiki>{{clr|10|5B}}</nowiki>
:{{clr|10|5B}}
;<nowiki>{{clr|11|5C}}</nowiki>
:{{clr|11|5C}}
;<nowiki>{{clr|12|5D}}</nowiki>
:{{clr|12|5D}}


===Reuse===
==Supported Game Titles and Examples==
Many of these colors can be used for multiple games such as DNF for example<br>
See the bottom of [[Mediawiki:Common.css]] for an exhaustive list and the exact CSS used.
{{clr|3|5A}} <code><nowiki>{{clr|3|5A}}</nowiki></code><br>
<div>
{{clr|1|5B}} <code><nowiki>{{clr|1|5B}}</nowiki></code><br>
 
{{clr|5|5S}} <code><nowiki>{{clr|5|5S}}</nowiki></code><br>
===Universal Colors===
{{clr|2|236MS}} <code><nowiki>{{clr|2|236MS}}</nowiki></code><br>
;<nowiki>{{color|1|5P}}</nowiki>
{{clr|4|AS}} <code><nowiki>{{clr|4|AS}}</nowiki></code><br>
:{{color|1|5P}}
;<nowiki>{{color|2|2K}}</nowiki>
:{{color|2|2K}}
;<nowiki>{{color|3|c.S}}</nowiki>
:{{color|3|c.S}}
;<nowiki>{{color|4|j.H}}</nowiki>
:{{color|4|j.H}}
;<nowiki>{{color|5|j.D}}</nowiki>
:{{color|5|j.D}}
;<nowiki>{{color|6|Very Easy}}</nowiki>
:{{color|6|Very Easy}}
;<nowiki>{{color|7|Medium}}</nowiki>
:{{color|7|Medium}}
;<nowiki>{{color|8|Very Hard}}</nowiki>
:{{color|8|Very Hard}}
;<nowiki>{{color|added|added}}</nowiki>
:{{color|added|added}}
;<nowiki>{{color|new|new}}</nowiki>
:{{color|new|new}}
;<nowiki>{{color|removed|removed}}</nowiki>
:{{color|removed|removed}}
;<nowiki>{{color|reworked|reworked}}</nowiki>
:{{color|reworked|reworked}}
;<nowiki>{{color|buff|buff}}</nowiki>
:{{color|buff|buff}}
;<nowiki>{{color|nerf|nerf}}</nowiki>
:{{color|nerf|nerf}}
 
To use equal signs ("=") in the text field, either add <code>2=</code> before your text or wrap the "=" in <code><nowiki><nowiki></nowiki></code> tags
;<nowiki>{{color|new|Template breaks =(}}</nowiki>
:{{color|new|Template breaks =(}}
;<nowiki>{{color|new|2=Template works =)}}</nowiki>
:{{color|new|2=Template works =)}}
;<nowiki>{{</nowiki>color|new|This also works <nowiki><</nowiki>nowiki<nowiki>></nowiki>=<nowiki></</nowiki>nowiki<nowiki>></nowiki>)<nowiki>}}</nowiki>
:{{color|new|This also works <nowiki>=</nowiki>)}}
 
===HTML colors===
;<nowiki>{{color|ForestGreen|Forest Green text}}</nowiki>
:{{color|ForestGreen|Forest Green text}}
;<nowiki>{{clr|#f00|Red text}}</nowiki>
:{{clr|#f00|Red text}}
 
===[[GGACR]], [[GGML]], [[GGXRD-R2]], [[GGST]] Pages===
;<nowiki>{{color|1|5P}} or {{color|P|5P}}</nowiki>
:{{color|1|5P}}
;<nowiki>{{color|2|2K}} or {{color|K|2K}}</nowiki>
:{{color|2|2K}}
;<nowiki>{{color|3|c.S}} or {{color|S|c.S}}</nowiki>
:{{color|3|c.S}}
;<nowiki>{{color|4|j.H}} or {{color|H|j.H}}</nowiki>
:{{color|4|j.H}}
;<nowiki>{{color|5|j.D}} or {{color|D|j.D}}</nowiki>
:{{color|5|j.D}}
 
===[[BBCF]], [[BBCT]] Pages===
;<nowiki>{{color|A|5A}}</nowiki>
:{{color|game=BBCF|A|5A}}
;<nowiki>{{color|B|2B}}</nowiki>
:{{color|game=BBCF|B|2B}}
;<nowiki>{{color|C|6C}}</nowiki>
:{{color|game=BBCF|C|6C}}
;<nowiki>{{color|D|j.D}}</nowiki>
:{{color|game=BBCF|D|j.D}}
 
===[[BBTag]] Pages===
;<nowiki>{{color|1|5A}} or {{color|A|5A}}</nowiki>
:{{color|game=BBTag|1|5A}}
;<nowiki>{{color|2|2B}} or {{color|B|2B}}</nowiki>
:{{color|game=BBTag|2|2B}}
;<nowiki>{{color|3|5C}} or {{color|C|5C}}</nowiki>
:{{color|game=BBTag|3|5C}}
;<nowiki>{{color|4|5D}} or {{color|D|5D}}</nowiki>
:{{color|game=BBTag|4|5D}}
;<nowiki>{{color|5|5P}} or {{color|P|5P}}</nowiki>
:{{color|game=BBTag|5|5P}}
 
===[[DBFZ]] Pages===
;<nowiki>{{color|L|5L}}</nowiki>
:{{color|game=DBFZ|L|5L}}
;<nowiki>{{color|M|2M}}</nowiki>
:{{color|game=DBFZ|M|2M}}
;<nowiki>{{color|H|j.H}}</nowiki>
:{{color|game=DBFZ|H|j.H}}
;<nowiki>{{color|S|236S}}</nowiki>
:{{color|game=DBFZ|S|236S}}
 
===[[DNFD]] Pages===
;<nowiki>{{color|1|5A}} or {{color|A|5A}}</nowiki>
:{{color|game=DNFD|1|5A}}
;<nowiki>{{color|2|5B}} or {{color|B|5B}}</nowiki>
:{{color|game=DNFD|2|5B}}
;<nowiki>{{color|3|5S}} or {{color|S|5S}}</nowiki>
:{{color|game=DNFD|3|5S}}
;<nowiki>{{color|4|236M}} or {{color|M|236M}}</nowiki>
:{{color|game=DNFD|4|236MS}}
;<nowiki>{{color|5|AS}} or {{color|AS|AS}}</nowiki>
:{{color|game=DNFD|5|AS}}
 
===[[GBVS]] Pages===
;<nowiki>{{color|1|c.L}} or {{color|L|c.L}}</nowiki>
:{{color|game=GBVS|1|c.L}}
;<nowiki>{{color|2|2M}} or {{color|M|2M}}</nowiki>
:{{color|game=GBVS|2|2M}}
;<nowiki>{{color|3|f.H}} or {{color|H|f.H}}</nowiki>
:{{color|game=GBVS|3|f.H}}
;<nowiki>{{color|4|j.U}} or {{color|U|j.U}}</nowiki>
:{{color|game=GBVS|4|j.U}}
 
===[[HNK]] Pages===
;<nowiki>{{color|1|c.A}} or {{color|A|c.A}}</nowiki>
:{{color|game=HNK|A|c.A}}
;<nowiki>{{color|2|f.B}} or {{color|B|f.B}}</nowiki>
:{{color|game=HNK|B|f.B}}
;<nowiki>{{color|3|j.C}} or {{color|C|2C}}</nowiki>
:{{color|game=HNK|C|2C}}
;<nowiki>{{color|4|c.D}} or {{color|D|j.D}}</nowiki>
:{{color|game=HNK|D|j.D}}
;<nowiki>{{color|5|6E}} or {{color|E|6E}}</nowiki>
:{{color|game=HNK|E|6E}}
 
===[[P4Arena]], [[P4AU]], [[P4U2.5]] Pages===
;<nowiki>{{color|1|5A}} or {{color|A|5A}}</nowiki>
:{{color|game=P4U2.5|1|5A}}
;<nowiki>{{color|2|2B}} or {{color|B|2B}}</nowiki>
:{{color|game=P4U2.5|2|2B}}
;<nowiki>{{color|3|5C}} or {{color|C|5C}}</nowiki>
:{{color|game=P4U2.5|3|5C}}
;<nowiki>{{color|4|j.D}} or {{color|D|j.D}}</nowiki>
:{{color|game=P4U2.5|4|j.D}}
 
===[[SBX]] Pages===
;<nowiki>{{color|1|6A}} or {{color|A|6A}}</nowiki>
:{{color|game=SBX|1|6A}}
;<nowiki>{{color|2|5B}} or {{color|B|5B}}</nowiki>
:{{color|game=SBX|2|5B}}
;<nowiki>{{color|3|2C}} or {{color|C|2C}}</nowiki>
:{{color|game=SBX|3|2C}}
;<nowiki>{{color|4|236E}} or {{color|E|236E}}</nowiki>
:{{color|game=SBX|4|236E}}
 
===[[SMS]] Pages===
;<nowiki>{{color|1|LP}} or {{color|LP|6LP}}</nowiki>
:{{color|game=SMS|LP|6LP}}
;<nowiki>{{color|2|5HP}} or {{color|HP|5HP}}</nowiki>
:{{color|game=SMS|HP|5HP}}
;<nowiki>{{color|3|2LK}} or {{color|LK|2LK}}</nowiki>
:{{color|game=SMS|LK|2LK}}
;<nowiki>{{color|4|236HK}} or {{color|HK|236HK}}</nowiki>
:{{color|game=SMS|HK|236HK}}
 
{{doc/end}}
{{doc/end}}

Revision as of 05:00, 23 October 2022

{{color|X|Y|game=Z}} or {{clr|X|Y|game=Z}}
This template is used to apply color/style classes to text. Currently, it supports 8 pre-defined colors and 6 styles that are colorblind and "Dark mode" friendly, though the template can also be used for arbitrary HTML colors.

Colors applied with this template can be disabled or re-enabled through the use of "Monochrome mode" and "Colorful mode", so it is recommended to use this over applying text colors with style attribute, e.g. <span style="color: #ff0000;">Red text</span>.

The first parameter (X) is the color identifier code. The second parameter (Y) is the text to be styled.
Optionally, game name abbreviations (Z) can be used to force the colors of a specific game's buttons. If this is not provided, it will assume the game from the RootPageName of the current page, or if not found, default to Guilty Gear's button colors.

Supported Game Titles and Examples

See the bottom of Mediawiki:Common.css for an exhaustive list and the exact CSS used.

Universal Colors

{{color|1|5P}}
5P
{{color|2|2K}}
2K
{{color|3|c.S}}
c.S
{{color|4|j.H}}
j.H
{{color|5|j.D}}
j.D
{{color|6|Very Easy}}
Very Easy
{{color|7|Medium}}
Medium
{{color|8|Very Hard}}
Very Hard
{{color|added|added}}
added
{{color|new|new}}
new
{{color|removed|removed}}
removed
{{color|reworked|reworked}}
reworked
{{color|buff|buff}}
buff
{{color|nerf|nerf}}
nerf

To use equal signs ("=") in the text field, either add 2= before your text or wrap the "=" in <nowiki> tags

{{color|new|Template breaks =(}}
{{{2}}}
{{color|new|2=Template works =)}}
Template works =)
{{color|new|This also works <nowiki>=</nowiki>)}}
This also works =)

HTML colors

{{color|ForestGreen|Forest Green text}}
Forest Green text
{{clr|#f00|Red text}}
Red text

GGACR, GGML, GGXRD-R2, GGST Pages

{{color|1|5P}} or {{color|P|5P}}
5P
{{color|2|2K}} or {{color|K|2K}}
2K
{{color|3|c.S}} or {{color|S|c.S}}
c.S
{{color|4|j.H}} or {{color|H|j.H}}
j.H
{{color|5|j.D}} or {{color|D|j.D}}
j.D

BBCF, BBCT Pages

{{color|A|5A}}
5A
{{color|B|2B}}
2B
{{color|C|6C}}
6C
{{color|D|j.D}}
j.D

BBTag Pages

{{color|1|5A}} or {{color|A|5A}}
5A
{{color|2|2B}} or {{color|B|2B}}
2B
{{color|3|5C}} or {{color|C|5C}}
5C
{{color|4|5D}} or {{color|D|5D}}
5D
{{color|5|5P}} or {{color|P|5P}}
5P

DBFZ Pages

{{color|L|5L}}
5L
{{color|M|2M}}
2M
{{color|H|j.H}}
j.H
{{color|S|236S}}
236S

DNFD Pages

{{color|1|5A}} or {{color|A|5A}}
5A
{{color|2|5B}} or {{color|B|5B}}
5B
{{color|3|5S}} or {{color|S|5S}}
5S
{{color|4|236M}} or {{color|M|236M}}
236MS
{{color|5|AS}} or {{color|AS|AS}}
AS

GBVS Pages

{{color|1|c.L}} or {{color|L|c.L}}
c.L
{{color|2|2M}} or {{color|M|2M}}
2M
{{color|3|f.H}} or {{color|H|f.H}}
f.H
{{color|4|j.U}} or {{color|U|j.U}}
j.U

HNK Pages

{{color|1|c.A}} or {{color|A|c.A}}
c.A
{{color|2|f.B}} or {{color|B|f.B}}
f.B
{{color|3|j.C}} or {{color|C|2C}}
2C
{{color|4|c.D}} or {{color|D|j.D}}
j.D
{{color|5|6E}} or {{color|E|6E}}
6E

P4Arena, P4AU, P4U2.5 Pages

{{color|1|5A}} or {{color|A|5A}}
5A
{{color|2|2B}} or {{color|B|2B}}
2B
{{color|3|5C}} or {{color|C|5C}}
5C
{{color|4|j.D}} or {{color|D|j.D}}
j.D

SBX Pages

{{color|1|6A}} or {{color|A|6A}}
6A
{{color|2|5B}} or {{color|B|5B}}
5B
{{color|3|2C}} or {{color|C|2C}}
2C
{{color|4|236E}} or {{color|E|236E}}
236E

SMS Pages

{{color|1|LP}} or {{color|LP|6LP}}
6LP
{{color|2|5HP}} or {{color|HP|5HP}}
5HP
{{color|3|2LK}} or {{color|LK|2LK}}
2LK
{{color|4|236HK}} or {{color|HK|236HK}}
236HK

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.