Template:Color/doc: Difference between revisions

Template page
(→‎GBVS, GBVSR Pages: Remove S coloring)
 
(25 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{doc/start}}
{{doc/start}}
<pre>
<pre>{{color|X|Y|game=Z}} or {{clr|X|Y|game=Z}}</pre>
<nowiki>{{color|X|Y|game=Z}}</nowiki> or <nowiki>{{clr|X|Y|game=Z}}</nowiki>
This template is used to apply color/style classes to text.<br>
This template is used to apply pre-defined 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>.
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.
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.
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>
 
==Equals sign==
To use equals sign ("=") in the text field, there are a couple of workarounds:
* Use the magic word <code><nowiki>{{=}}</nowiki></code>
<code><nowiki>{{color|new|2 + 2 {{=}} 4}}</nowiki></code> produces {{BalanceBadge|new|2 + 2 {{=}} 4}}
* Use the HTML entity <code>&amp;#61;</code>
<code><nowiki>{{color|new|2 + 2 &amp;#61; 4}}</nowiki></code> produces {{BalanceBadge|new|2 + 2 &#61; 4}}
* Add <code>2=</code> before your text
<code><nowiki>{{color|new|2=2 + 2 = 4}}</nowiki></code> produces {{BalanceBadge|new|2=2 + 2 = 4}}
* Wrap the "=" in <code><nowiki><nowiki></nowiki></code> tags
<code><nowiki>{{</nowiki>color|new|2 + 2 <nowiki><</nowiki>nowiki<nowiki>></nowiki>=<nowiki></</nowiki>nowiki<nowiki>></nowiki><nowiki> 4}}</nowiki></code> produces {{BalanceBadge|new|2 + 2 <nowiki>=</nowiki> 4}}


==Supported Game Titles and Examples==
==Supported Game Titles and Examples==
See the bottom of [[Mediawiki:Common.css]] for an exhaustive list and the exact CSS used.  
The styles for this template are contained within [[Template:Color/styles.css]].  
<div>
<div>


===Simple coloring===
===Universal Colors===
;<nowiki>{{color|1|5P}}</nowiki>
:{{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}}
 
===Balance Badge Template===
These have since been replaced by [[Template:BalanceBadge]]
 
===HTML colors===
;<nowiki>{{color|ForestGreen|Forest Green text}}</nowiki>
;<nowiki>{{color|ForestGreen|Forest Green text}}</nowiki>
:{{color|ForestGreen|Forest Green text}}
:{{color|ForestGreen|Forest Green text}}
;<nowiki>{{clr|#f00|Red text}}</nowiki>
;<nowiki>{{clr|#f00|Red text}}</nowiki>
:{{clr|#f00|Red text}}
:{{clr|#f00|Red text}}
To use equal signs ("=") in the text field, add "2=" before your text
;<nowiki>{{color|blue|Template breaks =(}}</nowiki>
:{{color|blue|Template breaks =(}}
;<nowiki>{{color|blue|2=Template works =)}}</nowiki>
:{{color|blue|2=Template works =)}}


===[[GGACR]], [[GGML]], [[GGXRD-R2]], [[GGST]] Pages===
===[[GGACR]], [[GGML]], [[GGXRD-R2]], [[GGST]] Pages===
Line 37: Line 58:
;<nowiki>{{color|5|j.D}} or {{color|D|j.D}}</nowiki>
;<nowiki>{{color|5|j.D}} or {{color|D|j.D}}</nowiki>
:{{color|5|j.D}}
:{{color|5|j.D}}
</div>


===[[BBCF]] Pages===
===[[BBCF]], [[BBCT]] Pages===
;<nowiki>{{color|A|5A}}</nowiki>
;<nowiki>{{color|A|5A}}</nowiki>
:{{color|game=BBCF|A|5A}}
:{{color|game=BBCF|A|5A}}
Line 63: Line 83:
===[[DBFZ]] Pages===
===[[DBFZ]] Pages===
;<nowiki>{{color|L|5L}}</nowiki>
;<nowiki>{{color|L|5L}}</nowiki>
:{{color|game=DBFZ|1|5L}}
:{{color|game=DBFZ|L|5L}}
;<nowiki>{{color|M|2M}}</nowiki>
;<nowiki>{{color|M|2M}}</nowiki>
:{{color|game=DBFZ|2|2M}}
:{{color|game=DBFZ|M|2M}}
;<nowiki>{{color|H|j.H}}</nowiki>
;<nowiki>{{color|H|j.H}}</nowiki>
:{{color|game=DBFZ|3|j.H}}
:{{color|game=DBFZ|H|j.H}}
;<nowiki>{{color|S|236S}}</nowiki>
;<nowiki>{{color|S|236S}}</nowiki>
:{{color|game=DBFZ|4|236S}}
:{{color|game=DBFZ|S|236S}}


===[[DNFD]] Pages===
===[[DNFD]] Pages===
Line 83: Line 103:
:{{color|game=DNFD|5|AS}}
:{{color|game=DNFD|5|AS}}


===[[GBVS]] Pages===
===[[GBVS]], [[GBVSR]] Pages===
;<nowiki>{{color|1|c.L}} or {{color|L|c.L}}</nowiki>
;<nowiki>{{color|1|c.L}} or {{color|L|c.L}}</nowiki>
:{{color|game=GBVS|1|c.L}}
:{{color|game=GBVS|L|c.L}}
;<nowiki>{{color|2|2M}} or {{color|M|2M}}</nowiki>
;<nowiki>{{color|2|2M}} or {{color|M|2M}}</nowiki>
:{{color|game=GBVS|2|2M}}
:{{color|game=GBVS|M|2M}}
;<nowiki>{{color|3|f.H}} or {{color|H|f.H}}</nowiki>
;<nowiki>{{color|3|f.H}} or {{color|H|f.H}}</nowiki>
:{{color|game=GBVS|3|f.H}}
:{{color|game=GBVS|H|f.H}}
;<nowiki>{{color|4|j.U}} or {{color|U|j.U}}</nowiki>
;<nowiki>{{color|4|j.U}} or {{color|U|j.U}}</nowiki>
:{{color|game=GBVS|4|j.U}}
:{{color|game=GBVS|U|j.U}}
;<nowiki>{{color|6|G}} or {{color|G|G}}</nowiki>
:{{color|game=GBVS|G|4G}}


===[[HNK]] Pages===
===[[HNK]] Pages===
;<nowiki>{{color|1|c.A}} or {{color|A|c.A}}</nowiki>
;<nowiki>{{color|1|c.A}} or {{color|A|c.A}}</nowiki>
:{{color|game=HNK|1|c.A}}
:{{color|game=HNK|A|c.A}}
;<nowiki>{{color|2|f.B}} or {{color|B|f.B}}</nowiki>
;<nowiki>{{color|2|f.B}} or {{color|B|f.B}}</nowiki>
:{{color|game=HNK|2|f.B}}
:{{color|game=HNK|B|f.B}}
;<nowiki>{{color|3|j.C}} or {{color|C|2C}}</nowiki>
;<nowiki>{{color|3|j.C}} or {{color|C|2C}}</nowiki>
:{{color|game=HNK|3|2C}}
:{{color|game=HNK|C|2C}}
;<nowiki>{{color|4|c.D}} or {{color|D|j.D}}</nowiki>
;<nowiki>{{color|4|c.D}} or {{color|D|j.D}}</nowiki>
:{{color|game=HNK|4|j.D}}
:{{color|game=HNK|D|j.D}}
;<nowiki>{{color|5|6E}} or {{color|E|6E}}</nowiki>
;<nowiki>{{color|5|6E}} or {{color|E|6E}}</nowiki>
:{{color|game=HNK|5|6E}}
:{{color|game=HNK|E|6E}}


===[[P4Arena]], [[P4AU]], [[P4U2.5]] Pages===
===[[P4Arena]], [[P4AU]], [[P4U2.5]] Pages===
Line 115: Line 137:
:{{color|game=P4U2.5|4|j.D}}
:{{color|game=P4U2.5|4|j.D}}


===Universal Colors===
===[[SBX]] Pages===
;<nowiki>{{color|6|Very Easy}}</nowiki>
;<nowiki>{{color|1|6A}} or {{color|A|6A}}</nowiki>
:{{color|6|Very Easy}}
:{{color|game=SBX|1|6A}}
;<nowiki>{{color|7|Medium}}</nowiki>
;<nowiki>{{color|2|5B}} or {{color|B|5B}}</nowiki>
:{{color|7|Medium}}
:{{color|game=SBX|2|5B}}
;<nowiki>{{color|8|Very Hard}}</nowiki>
;<nowiki>{{color|3|2C}} or {{color|C|2C}}</nowiki>
:{{color|8|Very Hard}}
:{{color|game=SBX|3|2C}}
;<nowiki>{{color|added|added}}</nowiki>
;<nowiki>{{color|4|236E}} or {{color|E|236E}}</nowiki>
:{{color|added|added}}
:{{color|game=SBX|4|236E}}
;<nowiki>{{color|new|new}}</nowiki>
 
:{{color|new|new}}
===[[SMS]] Pages===
;<nowiki>{{color|removed|removed}}</nowiki>
;<nowiki>{{color|1|LP}} or {{color|LP|6LP}}</nowiki>
:{{color|removed|removed}}
:{{color|game=SMS|LP|6LP}}
;<nowiki>{{color|reworked|reworked}}</nowiki>
;<nowiki>{{color|2|5HP}} or {{color|HP|5HP}}</nowiki>
:{{color|reworked|reworked}}
:{{color|game=SMS|HP|5HP}}
;<nowiki>{{color|buff|buff}}</nowiki>
;<nowiki>{{color|3|2LK}} or {{color|LK|2LK}}</nowiki>
:{{color|buff|buff}}
:{{color|game=SMS|LK|2LK}}
;<nowiki>{{color|nerf|nerf}}</nowiki>
;<nowiki>{{color|4|236HK}} or {{color|HK|236HK}}</nowiki>
:{{color|nerf|nerf}}
:{{color|game=SMS|HK|236HK}}


{{doc/end}}
{{doc/end}}

Latest revision as of 02:15, 3 January 2024

{{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. Red text.

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.

Equals sign

To use equals sign ("=") in the text field, there are a couple of workarounds:

  • Use the magic word {{=}}

{{color|new|2 + 2 {{=}} 4}} produces 2 + 2 = 4

  • Use the HTML entity &#61;

{{color|new|2 + 2 &#61; 4}} produces 2 + 2 = 4

  • Add 2= before your text

{{color|new|2=2 + 2 = 4}} produces 2 + 2 = 4

  • Wrap the "=" in <nowiki> tags

{{color|new|2 + 2 <nowiki>=</nowiki> 4}} produces 2 + 2 = 4

Supported Game Titles and Examples

The styles for this template are contained within Template:Color/styles.css.

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

Balance Badge Template

These have since been replaced by Template:BalanceBadge

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, GBVSR 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
{{color|6|G}} or {{color|G|G}}
4G

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.