Difference between revisions of "Template:Co/doc"

From EVE University Wiki
Jump to: navigation, search
m
m (| are no brackets.)
 
(3 intermediate revisions by the same user not shown)
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>. 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|#0000FF|#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 ...
 +
: {{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>
 
<includeonly>[[Category:Formatting templates]]</includeonly>
 
<noinclude>[[Category:Template documentation]]</noinclude>
 
<noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 08:49, 1 July 2024

Description
This template is used to color some text.
Syntax
{{Co|<text color>|<background color>|<text>}}
{{Co|<text color>|<text>}}
Parameters
text color
Sets the text color. Default value is "inherit"[1]. Colors can be given either by color name[2] (e.g. red or green) or values[3] (like #FF0000).
background color
Sets the background color. Default value is "inherit". For valid values see text color.
text
The text to be colored.
Sample
{{co|red|This text isn't yellow.}}
gives ...
This text isn't yellow.
{{co||green|This text has a green background.}}
gives ...
This text has a green background.

Icon information square.png Note: Note the double pipe char || 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.

{{co|black|lightyellow|Text and background color.}}
gives ...
Text and background color.
{{co|#0033CC|This text uses an hex color code.}}
gives ...
This text uses an hex color code.
References
  1. ^ inherit - The color used by the HTML parent element.
  2. ^ https://www.w3schools.com/colors/colors_names.asp [2022-05-29]
  3. ^ https://www.w3schools.com/colors/colors_hex.asp [2022-05-29]