Template:Color/doc: Difference between revisions
Jump to navigation
Jump to search
(added doccumentation for text highlight) |
m (update format and examples) |
||
(One intermediate revision by the same user not shown) | |||
Line 4: | Line 4: | ||
== Useage == | == Useage == | ||
To be used to color text, or the background of text. | To be used to color text, or the background of text. | ||
< | :<code><nowiki>{{color|1|2|3|4}}</nowiki></code> | ||
:<code><nowiki>{{color|text color|background color|background padding|text you are coloring}}</nowiki></code> | |||
== Parameters == | == Parameters == | ||
Line 17: | Line 18: | ||
{{!}} 2 || Desired '''background''' color. Can either be an color name, or hex code. Leaving blank will leave the color as the default background color. || content || optional | {{!}} 2 || Desired '''background''' color. Can either be an color name, or hex code. Leaving blank will leave the color as the default background color. || content || optional | ||
{{!}}- | {{!}}- | ||
{{!}} 3 || Text that is being colored. || content || required | {{!}} 3 || Width of the padding of the background color. Useful for large highlights to avoid it looking too small. Default size of 2px. || content || required | ||
{{!}}- | |||
{{!}} 4 || Text that is being colored. || content || required | |||
|} | |} | ||
Line 23: | Line 26: | ||
Inputting the following: | Inputting the following: | ||
:<nowiki>{{color|blue||This text is blue!}}</nowiki> | :<code><nowiki>{{color|blue|||This text is blue!}}</nowiki></code> | ||
Will result in the following: | Will result in the following: | ||
:{{color|blue||This text is blue!}} | :{{color|blue|||This text is blue!}} | ||
---- | ---- | ||
Alternatively, a hex code for a non-html color can be used in order to specify a specific color. For example: | Alternatively, a hex code for a non-html color can be used in order to specify a specific color. For example: | ||
:<nowiki>{{color|# | :<code><nowiki>{{color|#1e92bd|||This is a random color!}}</nowiki></code> | ||
Will result in the following: | Will result in the following: | ||
:{{color|# | :{{color|#1e92bd|||This is a random color!}} | ||
---- | ---- | ||
Or even to add a highlight to a string of text: | |||
:<nowiki>{{color| | :<code><nowiki>This is {{color||yellow||important}} doccumentation.</nowiki></code> | ||
Which will result in the following: | Which will result in the following: | ||
:{{color| | :This is {{color||yellow||important}} doccumentation. | ||
---- | ---- | ||
And, it can be used in close conjunction for rapid color changes, and can be placed within one another: | |||
:<nowiki> | :<code><nowiki>{{color||lightgrey|{{color|red|||R}}{{color|orange|||A}}{{color|yellow|||I}}{{color|green|||N}}{{color|blue|||B}}{{color|indigo|||O}}{{color|violet|||W}}}}</nowiki></code> | ||
Which will result in the following: | Which will result in the following: | ||
: | :{{color||lightgrey|2px|{{color|red|||R}}{{color|orange|||A}}{{color|yellow|||I}}{{color|green|||N}}{{color|blue|||B}}{{color|indigo|||O}}{{color|violet|||W}}}} |
Latest revision as of 04:05, 20 March 2024
Documentation for Template:Color
Useage
To be used to color text, or the background of text.
{{color|1|2|3|4}}
{{color|text color|background color|background padding|text you are coloring}}
Parameters
Parameter | Description | Type | Status |
---|---|---|---|
1 | Desired text color, either a color name or Hex code. Leaving blank will leave the color as the default text color. | content | optional |
2 | Desired background color. Can either be an color name, or hex code. Leaving blank will leave the color as the default background color. | content | optional |
3 | Width of the padding of the background color. Useful for large highlights to avoid it looking too small. Default size of 2px. | content | required |
4 | Text that is being colored. | content | required |
Examples
Inputting the following:
{{color|blue|||This text is blue!}}
Will result in the following:
- This text is blue!
Alternatively, a hex code for a non-html color can be used in order to specify a specific color. For example:
{{color|#1e92bd|||This is a random color!}}
Will result in the following:
- This is a random color!
Or even to add a highlight to a string of text:
This is {{color||yellow||important}} doccumentation.
Which will result in the following:
- This is important doccumentation.
And, it can be used in close conjunction for rapid color changes, and can be placed within one another:
{{color||lightgrey|{{color|red|||R}}{{color|orange|||A}}{{color|yellow|||I}}{{color|green|||N}}{{color|blue|||B}}{{color|indigo|||O}}{{color|violet|||W}}}}
Which will result in the following:
- RAINBOW