Template:Co/doc: Difference between revisions

(5 intermediate revisions by 2 users not shown)

Line 1:

~~<noinclude>{{main|Template~~:~~Co}}</noinclude>~~

; Description

~~==Usage==~~

: This template is used to color some text.

~~{{code|<nowiki>{{co|<text color>|<background~~ color~~>|<~~text~~>}}</nowiki>}}~~

~~==Examples==~~

; Syntax

{{~~code~~|~~<nowiki>{{co~~|~~red~~||~~This~~ text ~~isn't yellow.}}</nowiki>~~}}

: {{T|Co|text color|background color|text}}

: {{T|Co|text color|text}}

{{~~code~~|<~~nowiki~~>{{co||green|~~This text has a~~ green ~~background.~~}}</~~nowiki~~>}}

:; Parameters

{{co||~~green|This~~ text ~~has a green background~~.~~}}<br>~~

::; text color : Sets the text color. Default value is "inherit"<ref>inherit - The color used by the HTML parent element.</ref>. Text color is passed through {{t|design var}} to automatically interpret and replace select color names with design variables. Colors can be given either by color name<ref>https://www.w3schools.com/colors/colors_names.asp [2022-05-29]</ref> (e.g. {{Co|red|red}} or {{Co|green|green}}) or values<ref>https://www.w3schools.com/colors/colors_hex.asp [2022-05-29]</ref> (like {{Co|#FF0000|#FF0000}}).

::; background color : Sets the background color. Default value is "inherit". For valid values see text color.

::; text : The text to be colored.

{{code|<nowiki>{{co|~~#0033CC|~~|This text ~~uses an HTML color code~~.}}</nowiki>}}

; Sample

: {{code|<nowiki>{{co|red|This text isn't yellow.}}</nowiki>}} gives ...

: {{co|red||This text isn't yellow.}}

Note the double ~~brackets~~ <~~code~~>||</~~code~~> which means that that section is empty. The background color parameter may be safely omitted without the use of double ~~brackets~~, but double ~~brackets~~ must be used if only a background color is desired.

: {{code|<nowiki>{{co||green|This text has a green background.}}</nowiki>}} gives ...

<includeonly>[[Category:~~Template~~]]</includeonly>

: {{co||green|This text has a green background.}}<br>

{{Note|Note the double pipe char <nowiki>||</nowiki> which means that that section is empty. The background color parameter may be safely omitted without the use of double pipes, but double pipes must be used if only a background color is desired.}}

: {{code|<nowiki>{{co|black|lightyellow|Text and background color.}}</nowiki>}} gives ...

: {{co|black|lightyellow|Text and background color.}}

: {{code|<nowiki>{{co|#0033CC|This text uses an hex color code.}}</nowiki>}} gives ...

: {{co|#0033CC||This text uses an hex color code.}}

; References

<includeonly>[[Category:Formatting templates]]</includeonly>

<noinclude>[[Category:Template documentation]]</noinclude>

@@ Line 1: / Line 1: @@
-<noinclude>{{main|Template:Co}}</noinclude>
+; Description
-==Usage==
+: This template is used to color some text.
-{{code|<nowiki>{{co|<text color>|<background color>|<text>}}</nowiki>}}
-==Examples==
+; Syntax
-{{code|<nowiki>{{co|red||This text isn't yellow.}}</nowiki>}}
+: {{T|Co|text color|background color|text}}
-{{co|red||This text isn't yellow.}}
+: {{T|Co|text color|text}}
-{{code|<nowiki>{{co||green|This text has a green background.}}</nowiki>}}
+:; Parameters
-{{co||green|This text has a green background.}}<br>
+::; text color : Sets the text color. Default value is "inherit"<ref>inherit - The color used by the HTML parent element.</ref>. Text color is passed through {{t|design var}} to automatically interpret and replace select color names with design variables. Colors can be given either by color name<ref>https://www.w3schools.com/colors/colors_names.asp [2022-05-29]</ref> (e.g. {{Co|red|red}} or {{Co|green|green}}) or values<ref>https://www.w3schools.com/colors/colors_hex.asp [2022-05-29]</ref> (like {{Co|#FF0000|#FF0000}}).
+::; background color : Sets the background color. Default value is "inherit". For valid values see text color.
+::; text : The text to be colored.
-{{code|<nowiki>{{co|#0033CC||This text uses an HTML color code.}}</nowiki>}}
+; Sample
-{{co|#0033CC||This text uses an HTML color code.}}
+: {{code|<nowiki>{{co|red|This text isn't yellow.}}</nowiki>}} gives ...
+: {{co|red||This text isn't yellow.}}
-Note the double brackets <code>||</code> which means that that section is empty. The background color parameter may be safely omitted without the use of double brackets, but double brackets must be used if only a background color is desired.
+: {{code|<nowiki>{{co||green|This text has a green background.}}</nowiki>}} gives ...
-<includeonly>[[Category:Template]]</includeonly>
+: {{co||green|This text has a green background.}}<br>
+{{Note|Note the double pipe char <nowiki>||</nowiki> which means that that section is empty. The background color parameter may be safely omitted without the use of double pipes, but double pipes must be used if only a background color is desired.}}
+: {{code|<nowiki>{{co|black|lightyellow|Text and background color.}}</nowiki>}} gives ...
+: {{co|black|lightyellow|Text and background color.}}
+: {{code|<nowiki>{{co|#0033CC|This text uses an hex color code.}}</nowiki>}} gives ...
+: {{co|#0033CC||This text uses an hex color code.}}
+; References
+<references />
+<includeonly>[[Category:Formatting templates]]</includeonly>
 <noinclude>[[Category:Template documentation]]</noinclude>