Revision [518]

This is an old revision of ColorActionInfo made by DarTar on 2008-01-30 04:10:02.

 

HomePage

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.



Documentation


Short description
Renders a string as colored text.

Parameters
nametyperequired?defaultdescription
textstringmandatory-the text you want to display colored
cstringoptional- color name or hex-value for the text
bgstringoptional-
since 1.1.6.2
(html) color name or hex-value for the background
fgstringoptional-
since 1.1.6.2
alias for 'c', introduced to fit with 'bg'
hexstringoptional-alias for 'c', kept for backwards-compatibility;

Color names
namecolor
aqua
black
blue
fuchsia
gray
green
lime
maroon
navy
olive
purple
red
silver
teal
white
yellow

Long description
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.

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

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

If you want to use hex values:

{{color hex="#DD0000" text="This is another test."}}
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):

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

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

Release Notes


Authors

CategoryEN
There are no comments on this page.
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki