Template:Color/doc: Difference between revisions

← Older edit

Latest revision as of 18:57, 23 October 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

No description.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Text color	`1`	Desired color, either a [https://www.w3schools.com/tags/ref_colornames.asp color name] or Hex code. Leaving blank will leave the color as the default text color.	Content	suggested
Background Color	`2`	Desired background color. Can either be a color name, or hex code. Leaving blank will leave the color as the default background color.	Content	optional
Background color width	`3`	Width of the padding of the background color. Useful for large highlights to avoid it looking too small. Default size of 2px.	Content	optional
Text	`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

@@ Line 1: / Line 1: @@
-<includeonly>Template doc page transcluded from {{SUBJECTPAGENAME}}/doc</includeonly><noinclude>Documentation for [[Template:Color]]</br></br></noinclude>
+<includeonly>Template doc page transcluded from [[{{SUBJECTPAGENAME}}/doc]]</includeonly><noinclude>Documentation for [[Template:Color]]</br></br></noinclude>
 <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 == Useage ==
-To be used to color text.
+To be used to color text, or the background of text.
-<pre>{{color|1|2}}</pre>
-<pre>{{color|color to change|text you are coloring}}</pre>
+:<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 ==
-{| class="wikitable"
+<templatedata>
-{{!}}-
+{
-! Parameter || Description || Type|| Status
+	"params": {
-{{!}}-
+		"1": {
-{{!}} 1 {{!!}} Desired color, either a [https://www.w3schools.com/tags/ref_colornames.asp color name] or Hex code. || content || required
+			"label": "Text color",
-{{!}}-
+			"description": "Desired color, either a [https://www.w3schools.com/tags/ref_colornames.asp color name] or Hex code. Leaving blank will leave the color as the default text color.",
-{{!}} 2 || Text that is being colored. || content || required
+			"type": "content",
-|}
+			"suggested": true
+		},
+		"2": {
+			"label": "Background Color",
+			"description": "Desired background color. Can either be a color name, or hex code. Leaving blank will leave the color as the default background color.",
+			"type": "content"
+		},
+		"3": {
+			"label": "Background color width",
+			"description": "Width of the padding of the background color. Useful for large highlights to avoid it looking too small. Default size of 2px.",
+			"type": "content"
+		},
+		"4": {
+			"label": "Text",
+			"description": "Text that is being colored.",
+			"type": "content",
+			"required": true
+		}
+	},
+	"format": "inline"
+}
+</templatedata>
 == Examples ==
 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:
-:{{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:
-:<nowiki>{{color|#abcdef|This is a random color!}}</nowiki>
+:<code><nowiki>{{color|#1e92bd|||This is a random color!}}</nowiki></code>
 Will result in the following:
-:{{color|#abcdef|This is a random color!}}
+:{{color|#1e92bd|||This is a random color!}}
+----
+Or even to add a highlight to a string of text:
+:<code><nowiki>This is {{color||yellow||important}} doccumentation.</nowiki></code>
+Which will result in the following:
+:This is {{color||yellow||important}} doccumentation.
 ----
-And, it can be used in close conjunction for rapid color changes:
+And, it can be used in close conjunction for rapid color changes, and can be placed within one another:
-:<nowiki>{{color|red|Red}} and {{color|orange|Orange}}</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:
-:{{color|red|Red}} and {{color|orange|Orange}}
+:{{color||lightgrey|2px|{{color|red|||R}}{{color|orange|||A}}{{color|yellow|||I}}{{color|green|||N}}{{color|blue|||B}}{{color|indigo|||O}}{{color|violet|||W}}}}