Roxen Interactive RXML Help

<gtext-url></gtext-url>

Returns an internal URL to an image with the specified attributes applied.

Attributes

short

Returns a relative path to the image, i.e. a shorter one.

verbatim

By default the gtext tag will try to make typographical enhancements to the text to make the resulting image as eye pleasing as possible. If you want to turn this feature off, add this attribute to the tag.

alpha

alpha=path

Use the specified image as an alpha channel, together with the background attribute.

background

background=path

Specifies the image to use as background.

tile

Tiles the background and foreground images if they are smaller than the actual image.

mirrortile

Tiles the background and foreground images around x-axis and y-axis for odd frames, creating seamless textures.

bevel

bevel=width

Draws a bevel-box around the text.

bgcolor

bgcolor=color

Sets the background color. If the module "HTML color wiretap" is loaded, they are taken from the normal HTML tags in your document, like body, table, tr and td.

If you set the background color, it is probably best to add the notrans attribute as well.

bgturbulence

bgturbulence=frequency,color;frequency,color...

Apply a turbulence effect on the background.

bold

Use a bold version of the font, if available. Can not be used together with the black or light attributes.

black

Use a black, or heavy, version of the font, if available. Can not be used together with the bold or light attributes.

light

Use a light version of the font, if available. Can not be used together with the bold or black attributes.

italic

Use an italic version of the font, if available.

bshadow

bshadow=distance

Draw a blured black drop-shadow behind the text. Using 0 as distance does not currently place the shadow directly below the text. Using negative values for distance is possible, but you might have to add 'spacing'.

chisel

Make the text look like it has been cut into the background.

crop

Remove all white-space around the image.

encoding

encoding=string

Choose with which charset the text is encoded with.

fadein

fadein=blur,steps,delay,initialdelay

Generates an animated GIF file of a fade-in effect.

fgcolor

fgcolor=color

Sets the text color.

font

font=string

Selects which font to use. You can get a list of all available fonts by using the list fonts task in the administration interface, or by using the <emit fonts> plugin.

fontsize

fontsize=number

Selects which size of the font that should be used.

format

format=string

Set the image format, e.g. "png".

fs

Apply floyd-steinberg dithering to the resulting image. Most of the time it is much better to increase the number of colors, instead of dithering the image, but sometimes when using very complex background images dithering is O.K.

ghost

ghost=dist,blur,color

Apply a ghost effect. Cannot be used together with shadow or magic coloring.

glow

glow=color

Apply a 'glow' filter to the image. Quite a CPU eater. Looks much better on a dark background, where a real 'glow' effect can be achieved.

maxlen

maxlen=number

Sets the maximum length of the text that will be rendered into an image, by default 300.

move

move=x,y

Moves the text relative to the upper left corner of the background image. This will not change the size of the image.

narrow

Use a narroe version of the font, if available.

notrans

Do not make the background transparent. Useful when making 'boxes' of color around the text.

nowhitespace

Removes all whitespaces before and after the real text.

opaque

opaque=percentage

Sets the 'opaque' value of the color used to draw the text. Default is 100%. In the example below, notice how the text color mixes with the two background colors.

outline

outline=color,extra-radius

Draw an outline around the text. Quite useful when combined with textscale.

pressed

Inverts the direction of the bevel box, to make it look like a button that is pressed down. The magic modifier will do this automatically.

quant

quant=number

Quantifies the image with this number of colors. Using a lower number will decrease the image (file)size, but make the text look more 'edgy', and if you use complex backgrounds or image textures, more colors will be neded. At most 255 colors can be used, and less than 2 is quite useless. It is advisable to use powers of 2 to optimize the palette allocation.

rescale

Rescale the background to fill the whole image.

rotate

rotate=angle

Rotates the image this number of degrees counter-clockwise.

scale

scale=number

Sets the scale of the image. Larger than 1.0 is enlargement.

scolor

scolor=color

Use this color for the shadow. Used with the shadow attribute.

scroll

scroll=width,steps,delay

Generate an animated GIF image of the text scrolling.

shadow

shadow=intensity,distance

Draw a blured black drop-shadow behind the text. Using 0 as distance does not currently place the shadow directly below the text. Using negative values for distance is possible,

size

size=width,height

Set the size of the image.

spacing

spacing=number

Add space around the text.

talign

talign={left, right, center}

Adjust the alignment of the text.

textbelow

textbelow=color

Place the text centered in a box of the given color below the image area. Useful together with background to make captions for images.

textbox

textbox=opaque,color

Draw a box with an opaque value below the text of the specified color.

textscale

textscale=color,color,color,color

Apply a color filter to the text. The colors are, respectively, upper left, lower left, upper right and lower right. It is probably a good idea to increase the 'quant' value when using this argument.

texture

texture=path

Uses the specified images as a field texture.

tile

Tiles the background and foreground images if they are smaller than the actual image.

xpad

xpad={percentage, integer ended with "px"}

Sets the padding between characters. The value can either be an relative change, in percent, or an absolute number of pixels, ended with the string "px". Note that different fonts reacts differently on these values and for some it will not have any effect at all. This depends on the type of the font and the font implementation.

xsize

xsize=number

Sets the width.

xspacing

xspacing=number

Sets the horizontal spacing.

ypad

ypad={percentage, integer ended with "px"}

Sets the padding beteen lines. Works as xpad.

ysize

ysize=number

Sets the height.

yspacing

yspacing=number

Sets the vertical spacing.

Timeout

The generated image will by default never expire, but in some circumstances it may be pertinent to limit the time the image and its associated data is kept. Its possible to set an (advisory) timeout on the image data using the following attributes.

unix-time

unix-time=number

Set the base expiry time to this absolute time.

If left out, the other attributes are relative to current time.

years

years=number

Add this number of years to the time this entry is valid.

months

months=number

Add this number of months to the time this entry is valid.

weeks

weeks=number

Add this number of weeks to the time this entry is valid.

days

days=number

Add this number of days to the time this entry is valid.

hours

hours=number

Add this number of hours to the time this entry is valid.

beats

beats=number

Add this number of beats to the time this entry is valid.

minutes

minutes=number

Add this number of minutes to the time this entry is valid.

seconds

seconds=number

Add this number of seconds to the time this entry is valid.