Wikka Documentation: ColorActionInfo

[1278] Latest edit on 2008-11-01 23:23:06 by DarTar [Removed HomePage link]

Deletions:
~~HomePage~~

[596] Edited on 2008-01-31 06:47:09 by DarTar [before 1.1.6.4 color name validation was less strict so these should work with any version]

Additions:

Deletions:

[594] Edited on 2008-01-31 05:33:01 by YanB [since 1.1.6.4]

Additions:

Deletions:

[593] Edited on 2008-01-31 05:27:22 by YanB [adding [since] notes]

Additions:

Color names
name	color
name	color

NOTE

This feature is available since:
WikkaWiki 1.1.6.1

since 1.1.6.2
two new parameters bg and fg have been introduced, and the colors are checked for validity. RGB syntax, Hex syntax and a wide range of color names are supported.
since 1.1.6.4
support for a number of invalid colornames, such as antiquewhite, lightgreen, ... has been discontinued. Although these colornames are supported by almost every known browser, they do not validate against the CSS specification. Currently supported colornames are: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, purple, red, silver, teal, white and yellow.

Deletions:

Since version 1.1.6.2 two new parameters bg and fg have been introduced, and the colors are checked for validity. RGB syntax, Hex syntax and a wide range of color names are supported.
Since 1.1.6.4 support for a number of invalid colornames, such as antiquewhite, lightgreen, ... has been discontinued. Although these colornames are supported by almost every known browser, they do not validate against the CSS specification. Currently supported colornames are: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, purple, red, silver, teal, white and yellow.

[564] Edited on 2008-01-30 18:36:57 by DarTar [minor edits]

Additions:
This is the documentation page for the color/colour action(s).

Usage:

{{color [text="This is my text"] [fg="red"] [bg="black"]}}

Deletions:
~~This is the documentation page for the Color / Colour action(s).~~

bg	string	optional	-	since 1.1.6.2 color name or hex-value for the background
fg	string	optional	-	since 1.1.6.2 foreground color, alias for `c`, introduced to fit with `bg`
hex	string	optional	-	alias for `c`, kept for backwards-compatibility;

Once the planned 'autodoc' feature for actions is "live", this page will contain the automatically-generated documentation by just including an action; for now, I've just manually created the text.
Usage:

bg	string	optional	-	since 1.1.6.2 (html) color name or hex-value for the background
fg	string	optional	-	since 1.1.6.2 alias for 'c', introduced to fit with 'bg'
hex	string	optional	-	alias for 'c', kept for backwards-compatibility;

{{color [text="This is my text"] [c="red"]}}

[518] Edited on 2008-01-30 04:10:02 by DarTar [adding color name table]

Additions:

Deletions:

[517] Edited on 2008-01-30 04:02:24 by DarTar [formatting parameter table]

Additions:

Deletions:

Color names
name	type	required?	default	description
name	color
aqua
black
blue
fuchsia
gray
green
lime
maroon
navy
olive
purple
red
silver
teal
white
yellow
name	type	required?	default	description

Parameters

[516] Edited on 2008-01-30 03:59:08 by DarTar [minor edits]

Additions:
With {{color}} action (or its alias {{colour}}) you can specify text color using either one of HTML defined names or a hex value (with the former one taking priority). An optional background color can also be specified. Note that you must specify a text and either use "fg", "c" or "hex" for the color.
Deletions:
With the actions "color" and "colour" (the later one is an alias) you can specify text color either as one of HTML defined names or as a hex value (with the former one taking priority). An optional background color can also be specified. Note that you must specify a text and either use "fg", "c" or "hex" for the color.

[515] Edited on 2008-01-30 03:57:30 by DarTar [minor edits]

Additions:

Since version 1.1.6.2 two new parameters bg and fg have been introduced, and the colors are checked for validity. RGB syntax, Hex syntax and a wide range of color names are supported.
Since 1.1.6.4 support for a number of invalid colornames, such as antiquewhite, lightgreen, ... has been discontinued. Although these colornames are supported by almost every known browser, they do not validate against the CSS specification. Currently supported colornames are: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, purple, red, silver, teal, white and yellow.

Deletions:

For versions 1.1.6.2 and 1.1.6.3, parameters bg and fg were introduced, and the colors were checked for validity. RGB syntax, Hex syntax and a wide range of color names were supported.
Since 1.1.6.4, support for a number of invalid colornames, like antiquewhite, lightgreen, ... has been discontinued. Although these colornames are supported by almost every known browser, they do not validate against the CSS specification. Currently supported colornames are: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, purple, red, silver, teal, white and yellow.

[514] Edited on 2008-01-30 03:39:50 by DarTar [slight editing]

Additions:
With the actions "color" and "colour" (the later one is an alias) you can specify text color either as one of HTML defined names or as a hex value (with the former one taking priority). An optional background color can also be specified. Note that you must specify a text and either use "fg", "c" or "hex" for the color.

c	string	optional	-	color name or hex-value for the text
bg	string	optional	-	since 1.1.6.2 (html) color name or hex-value for the background
fg	string	optional	-	since 1.1.6.2 alias for 'c', introduced to fit with 'bg'

{{color [text="This is my text"] [c="red"]}}

Examples:

{{color c="green" text="This is a test."}}
{{color hex="#DD0000" text="This is another test."}}
{{color fg="#FF0000" bg="#000000" text="This is colored text on colored background"}}
{{color fg="yellow" bg="black" text="This is colored text on colored background"}}

Versions 1.1.6.1 and below had support for parameters text, c and hex only, and no check were performed about these values.
For versions 1.1.6.2 and 1.1.6.3, parameters bg and fg were introduced, and the colors were checked for validity. RGB syntax, Hex syntax and a wide range of color names were supported.
Since 1.1.6.4, support for a number of invalid colornames, like antiquewhite, lightgreen, ... has been discontinued. Although these colornames are supported by almost every known browser, they do not validate against the CSS specification. Currently supported colornames are: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, purple, red, silver, teal, white and yellow.

c	string	optional	-	name or hex-value of the color for the text
bg since 1.1.6.2	string	optional	-	name or hex-value for the backgroundcolor
fg since 1.1.6.2	string	optional	-	alias for 'c', introduced to fit with 'bg'

Deletions:
With the actions "color" and "colour" (the later one is a synonymon) you can specify the color either as one of HTML defined names or as a hex-value (with the former one taking priority). An optional background color can also be specified.

c string optional - name or hex-value of the color for the text

bg
since 1.1.6.2
string optional - name or hex-value for the backgroundcolor

fg
since 1.1.6.2
string optional - alias for 'c', introduced to fit with 'bg'

Note that you must add a text and either use "fg", "c" or "hex" for the color.

{{color [text="This is my text"] [c="red"]}}

Examples:

{{color c="green" text="This is a test."}}

gives:

{{color hex="#DD0000" text="This is another test."}}

to give:

{{color fg="#FF0000" bg="#000000" text="This is colored text on colored background"}}

{{color fg="yellow" bg="black" text="This is colored text on colored background"}}

Versions 1.1.6.1 and below had support for parameters text, c and hex only, and no check were performed about these values.
For versions 1.1.6.2 and 1.1.6.3, parameters bg and fg were introduced, and the colors were checked for validity. RGB syntax, Hex syntax and a wide range of color names were supported.
Since 1.1.6.4, support for a number of invalid colornames, like antiquewhite, lightgreen, ... where removed, as these colornames, though supported by almost every known browser, aren't validating against CSS specification. Supported colornames are now: 'aqua', 'black', 'blue', 'fuchsia', 'gray', 'green', 'lime', 'maroon', 'navy', 'olive', 'purple', 'red', 'silver', 'teal', 'white' and 'yellow'.

[513] Edited on 2008-01-30 00:37:34 by DotMG [Release Notes section, documenting "removing support for invalid colornames"]

Additions:
With the actions "color" and "colour" (the later one is a synonymon) you can specify the color either as one of HTML defined names or as a hex-value (with the former one taking priority). An optional background color can also be specified.

name	type	required?	default	description
text	string	mandatory	-	the text you want to display colored
c	string	optional	-	name or hex-value of the color for the text
bg since 1.1.6.2	string	optional	-	name or hex-value for the backgroundcolor
fg since 1.1.6.2	string	optional	-	alias for 'c', introduced to fit with 'bg'
hex	string	optional	-	alias for 'c', kept for backwards-compatibility;

Note that you must add a text and either use "fg", "c" or "hex" for the color.

{{color fg="yellow" bg="black" text="This is colored text on colored background"}}

This is colored text on colored background

Release Notes

Versions 1.1.6.1 and below had support for parameters text, c and hex only, and no check were performed about these values.
For versions 1.1.6.2 and 1.1.6.3, parameters bg and fg were introduced, and the colors were checked for validity. RGB syntax, Hex syntax and a wide range of color names were supported.
Since 1.1.6.4, support for a number of invalid colornames, like antiquewhite, lightgreen, ... where removed, as these colornames, though supported by almost every known browser, aren't validating against CSS specification. Supported colornames are now: 'aqua', 'black', 'blue', 'fuchsia', 'gray', 'green', 'lime', 'maroon', 'navy', 'olive', 'purple', 'red', 'silver', 'teal', 'white' and 'yellow'.

Deletions:

name type required? default description

text string mandatory - the text you want to display colored

c string optional - (html)name or hex-value of the color for the text

bg string optional - (html)name or hex-value for the backgroundcolor

fg string optional - alias for 'c', introduced to fit with 'bg'

hex string optional - alias for 'c', kept for backwards-compatibility;

With the actions "color" and "colour" (the later one is a synonymon) you can specifiy the color either as one of HTML defined names or as a hex-value (with the former one taking priority). An optional background color can also be specified.
Note that you must add a text and either use "c" or "hex" for the color.

{{color fg="lightgreen" bg="black" text="This is colored text on colored background"}}

This is colored text on colored background

[297] Edited on 2006-11-19 09:13:05 by YanB [edited, updated links]

Additions:
HomePage
Development page

{{color c="green" text="This is a test."}}

gives:

{{color hex="#DD0000" text="This is another test."}}

to give:

{{color fg="#FF0000" bg="#000000" text="This is colored text on colored background"}}

{{color fg="lightgreen" bg="black" text="This is colored text on colored background"}}

Nils Lindenberg (modifications)
Mahefa Randimbisoa (modification - RGB syntax)

CategoryEN
Deletions:
Wikka Documentation
Development page
{{color c="green" text="This is a test."}} gives:
{{color hex="#DD0000" text="This is another test."}} to give:
These examples won't work on this website itself - but on any wikka 1.1.6.2 and above
{{color fg="#FF0000" bg="#000000" text="This is colored text on colored background"}}
{{color fg="lightgreen" bg="black" text="This is colored text on colored background"}}

Nils Lindenberg (modifications)
Mahefa Randimbisoa (modification - RGB syntax)
CategoryDocumentation

[174] The oldest known version of this page was created on 2006-06-20 18:25:57 by NilsLindenberg [update]

History of recent changes for ColorActionInfo

Wikka Documentation

Color/ Colour Action Documentation

This is the documentation page for the Color / Colour action(s).

Once the planned 'autodoc' feature for actions is "live", this page will contain the automatically-generated documentation by just including an action; for now, I've just manually created the text.

See also
Development page

Documentation

Short description

Renders a string as colored text.

Parameters

name	type	required?	default	description
text	string	mandatory	-	the text you want to display colored
c	string	optional	-	(html)name or hex-value of the color for the text
bg	string	optional	-	(html)name or hex-value for the backgroundcolor
fg	string	optional	-	alias for 'c', introduced to fit with 'bg'
hex	string	optional	-	alias for 'c', kept for backwards-compatibility;

Long description

With the actions "color" and "colour" (the later one is a synonymon) you can specifiy the color either as one of HTML defined names or as a hex-value (with the former one taking priority). An optional background color can also be specified.

Note that you must add a text and either use "c" or "hex" for the color.

Usage:

{{color [text="This is my text"] [c="red"]}}

Examples:
{{color c="green" text="This is a test."}} gives:

This is a test.

If you want to use hex values:

{{color hex="#DD0000" text="This is another test."}} to give:

This is another test.

Alternatively, you can specify a foreground and background color using the fg and bg parameters (they accept both named and hex values):

These examples won't work on this website itself - but on any wikka 1.1.6.2 and above

{{color fg="#FF0000" bg="#000000" text="This is colored text on colored background"}}

This is colored text on colored background

{{color fg="lightgreen" bg="black" text="This is colored text on colored background"}}

This is colored text on colored background