Wikka Documentation : ColorActionInfo

HomePage :: Index :: RecentChanges :: Search :: Login/Register

Color/ Colour Action Documentation

This is the documentation page for the color/colour action(s).
See also
Development page


Documentation

NOTE
This feature is available since:
WikkaWiki 1.1.6.1


Short description
Renders a string as colored text.

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

Parameters
nametyperequired?defaultdescription
textstringmandatory-the text you want to display colored
bgstringoptional-
since 1.1.6.2
color name or hex-value for the background
fgstringoptional-
since 1.1.6.2
foreground color, alias for c, introduced to fit with bg
cstringoptional- color name or hex-value for the text
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.

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.
Creative Common Attribution-ShareAlike License
Valid XHTML 1.0 Transitional :: Valid CSS :: Powered by WikkaWiki
Page was generated in 0.0097 seconds