Roxen.git
/
server
/
base_server
/
image_cache.xml
version
»
Context lines:
10
20
40
80
file
none
3
Roxen.git/server/base_server/image_cache.xml:1:
<h2>Image cache attributes</h2>
-
<attr name='format' value='gif|jpeg|png|avs|gmp|bd|hrz|ilbm|psx|pnm|ps|pvr|tga|tiff|wbf|xbm|xpm' default='gif'>
-
The format to encode the image to. The formats available are:
-
<
table
>
-
<
tr
><
td
>gif</
td
><
td
>Graphics Interchange Format (might be missing in your roxen)</
td
></
tr
>
-
<
tr
><
td
>jpeg</
td
><
td
>Joint Photography Expert Group image compression</
td
></
tr
>
-
<
tr
><
td
>png</
td
><
td
>Portable Networks Graphics</
td
></
tr
>
-
<
tr
><
td
>avs</
td
><
td
></
td
></
tr
>
-
<
tr
><
td
>bmp</
td
><
td
>Windows BitMaP file</
td
></
tr
>
-
<
tr
><
td
>gd</
td
><
td
></
td
></
tr
>
-
<
tr
><
td
>hrz</
td
><
td
>HRZ is (was?) used for amatuer radio slow-scan TV.</
td
></
tr
>
-
<
tr
><
td
>ilbm</
td
><
td
></
td
></
tr
>
-
<
tr
><
td
>pcx</
td
><
td
>Zsoft PCX file format (PC / DOS)</
td
></
tr
>
-
<
tr
><
td
>pnm</
td
><
td
>Portable AnyMap</
td
></
tr
>
-
<
tr
><
td
>ps</
td
><
td
>Adobe PostScript file</
td
></
tr
>
-
<
tr
><
td
>pvr</
td
><
td
>Pover VR (dreamcast image)</
td
></
tr
>
-
<
tr
><
td
>tga</
td
><
td
>TrueVision Targa (PC / DOS)</
td
></
tr
>
-
<
tr
><
td
>tiff</
td
><
td
>Tag Image File Format</
td
></
tr
>
-
<
tr
><
td
>wbf</
td
><
td
>WAP Bitmap File</
td
></
tr
>
-
<
tr
><
td
>xbm</
td
><
td
>XWindows Bitmap File</
td
></
tr
>
-
<
tr
><
td
>xpm</
td
><
td
>XWindows Pixmap File</
td
></
tr
>
-
</
table
>
+
<attr name='format' value='gif|jpeg|png|avs|gmp|bd|hrz|ilbm|psx|pnm|ps|pvr|tga|tiff|wbf|xbm|xpm' default='gif'>
<p>
+
The format to encode the image to. The formats available are:
</p>
+
<
xtable
>
+
<
row
><
c
>gif</
c
><
c
>Graphics Interchange Format (might be missing in your roxen)</
c
></
row
>
+
<
row
><
c
>jpeg</
c
><
c
>Joint Photography Expert Group image compression</
c
></
row
>
+
<
row
><
c
>png</
c
><
c
>Portable Networks Graphics</
c
></
row
>
+
<
row
><
c
>avs</
c
><
c
></
c
></
row
>
+
<
row
><
c
>bmp</
c
><
c
>Windows BitMaP file</
c
></
row
>
+
<
row
><
c
>gd</
c
><
c
></
c
></
row
>
+
<
row
><
c
>hrz</
c
><
c
>HRZ is (was?) used for amatuer radio slow-scan TV.</
c
></
row
>
+
<
row
><
c
>ilbm</
c
><
c
></
c
></
row
>
+
<
row
><
c
>pcx</
c
><
c
>Zsoft PCX file format (PC / DOS)</
c
></
row
>
+
<
row
><
c
>pnm</
c
><
c
>Portable AnyMap</
c
></
row
>
+
<
row
><
c
>ps</
c
><
c
>Adobe PostScript file</
c
></
row
>
+
<
row
><
c
>pvr</
c
><
c
>Pover VR (dreamcast image)</
c
></
row
>
+
<
row
><
c
>tga</
c
><
c
>TrueVision Targa (PC / DOS)</
c
></
row
>
+
<
row
><
c
>tiff</
c
><
c
>Tag Image File Format</
c
></
row
>
+
<
row
><
c
>wbf</
c
><
c
>WAP Bitmap File</
c
></
row
>
+
<
row
><
c
>xbm</
c
><
c
>XWindows Bitmap File</
c
></
row
>
+
<
row
><
c
>xpm</
c
><
c
>XWindows Pixmap File</
c
></
row
>
+
</
xtable
>
<ex> <### format='png'/> </ex> <ex> <### format='gif'/> </ex> </attr>
-
<attr name='quant' value='number' default='format dependant'>
-
The number of colors to quantizize the image to.
+
<attr name='quant' value='number' default='format dependant'>
<p>
+
The number of colors to quantizize the image to.
</p>
<p> Default for gif is 32(+1 transparent), for most other formats (except black and white) is it unlimited.</p> <ex> <### quant='2'/> </ex> </attr> <h3>Color/alpha attributes</h3>
-
<attr name='dither' value='none|random|floyd-steinberg' default='none'>
-
Choose the dithering method.
-
<
table
>
-
<
tr
><
td
>none</
td
><
td
>No dithering is performed at all.</
td
></
tr
>
-
<
tr
><
td
>random</
td
><
td
>Random scatter dither. Not visually pleasing, but it is useful for very high resolution printing.</
td
></
tr
>
-
<
tr
><
td
>floyd-steinberg</
td
><
td
>Error diffusion dithering. Usually the best dithering method.</
td
></
tr
>
-
</
table
>
+
<attr name='dither' value='none|random|floyd-steinberg' default='none'>
<p>
+
Choose the dithering method.
</p>
+
<
xtable
>
+
<
row
><
c
>none</
c
><
c
>No dithering is performed at all.</
c
></
row
>
+
<
row
><
c
>random</
c
><
c
>Random scatter dither. Not visually pleasing, but it is useful for very high resolution printing.</
c
></
row
>
+
<
row
><
c
>floyd-steinberg</
c
><
c
>Error diffusion dithering. Usually the best dithering method.</
c
></
row
>
+
</
xtable
>
<ex> <### dither='random' quant='10'/> </ex> <ex> <### dither='floyd-steinberg' quant='10'/> </ex> </attr>
-
<attr name='true-alpha'>
+
<attr name='true-alpha'>
<p>
If present, render a real alpha channel instead of on/off alpha. If the file format only supports on/off alpha, the alpha channel is
-
dithered using a floyd-steinberg dither.
+
dithered using a floyd-steinberg dither.
</p>
<ex> <### opaque-value='20'/> </ex> <ex> <### opaque-value='20' true-alpha='1'/> </ex> </attr>
-
<attr name='background-color' value='color' default='taken from the page'>
-
The color to render the image against.
+
<attr name='background-color' value='color' default='taken from the page'>
<p>
+
The color to render the image against.
</p>
<ex> <### background-color='red' opaque-value='50'/> </ex> </attr>
-
<attr name='opaque-value' value='percentage' default='100'>
+
<attr name='opaque-value' value='percentage' default='100'>
<p>
The transparency value to use, 100 is fully opaque, and 0 is fully
-
transparent.
+
transparent.
</p>
</attr>
-
<attr name='cs-rgb-hsv' value='0|1' default='0'>
-
Perform rgb to hsv colorspace conversion.
+
<attr name='cs-rgb-hsv' value='0|1' default='0'>
<p>
+
Perform rgb to hsv colorspace conversion.
</p>
<ex> <### cs-rgb-hsv='1'/> </ex> </attr>
-
<attr name='gamma' value='number' default='1.0'>
-
Perform gamma adjustment.
+
<attr name='gamma' value='number' default='1.0'>
<p>
+
Perform gamma adjustment.
</p>
<ex> <### gamma='0.5'/> </ex> <ex> <### gamma='1.5'/> </ex> </attr>
-
<attr name='cs-grey' value='0|1' default='0'>
-
Perform rgb to greyscale colorspace conversion.
+
<attr name='cs-grey' value='0|1' default='0'>
<p>
+
Perform rgb to greyscale colorspace conversion.
</p>
<ex> <### cs-grey='1'/> </ex> </attr>
-
<attr name='cs-invert' value='0|1' default='0'>
-
Invert all colors
+
<attr name='cs-invert' value='0|1' default='0'>
<p>
+
Invert all colors
</p>
<ex> <### cs-invert='1'/> </ex> </attr>
-
<attr name='cs-hsv-rgb' value='0|1' default='0'>
-
Perform hsv to rgb colorspace conversion.
+
<attr name='cs-hsv-rgb' value='0|1' default='0'>
<p>
+
Perform hsv to rgb colorspace conversion.
</p>
<ex> <### cs-hsv-rgb='1'/> </ex> </attr> <h3>Transform attributes</h3>
-
<attr name='rotate-cw' value='degree' default='0'>
-
Rotate the image clock-wise.
+
<attr name='rotate-cw' value='degree' default='0'>
<p>
+
Rotate the image clock-wise.
</p>
<ex> <### rotate-cw='20'/> </ex> </attr>
-
<attr name='rotate-ccw' value='degree' default='0'>
-
Rotate the image counter clock-wise.
+
<attr name='rotate-ccw' value='degree' default='0'>
<p>
+
Rotate the image counter clock-wise.
</p>
</attr>
-
<attr name='rotate-unit' value='rad|deg|ndeg|part' default='deg'>
-
Select the unit to use while rotating.
+
<attr name='rotate-unit' value='rad|deg|ndeg|part' default='deg'>
<p>
+
Select the unit to use while rotating.
</p>
-
<
table
>
-
<
tr
><
td
>rad</
td
><
td
>Radians</
td
></
tr
>
-
<
tr
><
td
>deg</
td
><
td
>Degrees</
td
></
tr
>
-
<
tr
><
td
>ndeg</
td
><
td
>'New' degrees (400 for each full rotation)</
td
></
tr
>
-
<
tr
><
td
>part</
td
><
td
>0 - 1.0 (1.0 == full rotation)</
td
></
tr
>
-
</
table
>
+
<
xtable
>
+
<
row
><
c
>rad</
c
><
c
>Radians</
c
></
row
>
+
<
row
><
c
>deg</
c
><
c
>Degrees</
c
></
row
>
+
<
row
><
c
>ndeg</
c
><
c
>'New' degrees (400 for each full rotation)</
c
></
row
>
+
<
row
><
c
>part</
c
><
c
>0 - 1.0 (1.0 == full rotation)</
c
></
row
>
+
</
xtable
>
</attr>
-
<attr name='mirror-x' value='0|1' default='0'>
-
Mirror the image around the X-axis.
+
<attr name='mirror-x' value='0|1' default='0'>
<p>
+
Mirror the image around the X-axis.
</p>
</attr>
-
<attr name='mirror-y' value='0|1' default='0'>
-
Mirror the image around the Y-axis.
+
<attr name='mirror-y' value='0|1' default='0'>
<p>
+
Mirror the image around the Y-axis.
</p>
</attr>
-
<attr name='scale' value='fact' default='1.0'>
-
Scale fact times. (0.5 -> half size, 2.0 -> double size)
+
<attr name='scale' value='fact' default='1.0'>
<p>
+
Scale fact times. (0.5 -> half size, 2.0 -> double size)
</p>
<ex> <### scale='0.5'/> </ex> </attr>
-
<attr name='scale' value='x,y'>
+
<attr name='scale' value='x,y'>
<p>
Scale to the exact size x,y. If either of X or Y is zero, the image is scaled to the specified width or hight, and the value that is zero
-
is scaled in proportion to the other value.
+
is scaled in proportion to the other value.
</p>
<ex> <### scale='20,50'/> </ex> </attr>
-
<attr name='max-width' value='xsize'>
+
<attr name='max-width' value='xsize'>
<p>
If width is larger than 'xsize', scale width to 'xsize' while
-
keeping aspect.
+
keeping aspect.
</p>
</attr>
-
<attr name='max-height' value='ysize'>
+
<attr name='max-height' value='ysize'>
<p>
If width is larger than 'ysize', scale width to 'ysize' while
-
keeping aspect.
+
keeping aspect.
</p>
</attr>
-
<attr name='x-offset' value='pixels' default='0'>
-
Cut n pixels from the beginning of the X scale.
+
<attr name='x-offset' value='pixels' default='0'>
<p>
+
Cut n pixels from the beginning of the X scale.
</p>
<ex> <### x-offset='100'/> </ex> </attr>
-
<attr name='y-offset' value='pixels' default='0'>
-
Cut n pixels from the beginning of the Y scale.
+
<attr name='y-offset' value='pixels' default='0'>
<p>
+
Cut n pixels from the beginning of the Y scale.
</p>
</attr>
-
<attr name='x-size' value='pixels' default='whole image'>
-
Keep n pixels from the beginning of the X scale.
+
<attr name='x-size' value='pixels' default='whole image'>
<p>
+
Keep n pixels from the beginning of the X scale.
</p>
<ex> <### x-size='100'/> </ex> </attr>
-
<attr name='y-size' value='pixels' default='whole image'>
-
Keep n pixels from the beginning of the Y scale.
+
<attr name='y-size' value='pixels' default='whole image'>
<p>
+
Keep n pixels from the beginning of the Y scale.
</p>
</attr>
-
<attr name=crop value='x0,y0-x1,y1' default='whole image'>
-
Crop the image by specifying the pixel coordinates.
+
<attr name=crop value='x0,y0-x1,y1' default='whole image'>
<p>
+
Crop the image by specifying the pixel coordinates.
</p>
<ex> <### crop='50,28-150,92'/> </ex> </attr> <h3>Format specific attributes</h3>
-
<attr name='jpeg-quality' value='percentage' default='75'>
-
Set the quality on the output jpeg image.
+
<attr name='jpeg-quality' value='percentage' default='75'>
<p>
+
Set the quality on the output jpeg image.
</p>
<ex> <### format='jpeg' jpeg-quality='30'/> </ex> <ex> <### format='jpeg' jpeg-quality='1'/> </ex> </attr>
-
<attr name='jpeg-optimize' value='0|1' default='1'>
+
<attr name='jpeg-optimize' value='0|1' default='1'>
<p>
If 0, do not generate optimal tables. Somewhat faster, but produces
-
bigger files.
+
bigger files.
</p>
</attr>
-
<attr name='jpeg-progressive=' value='0|1' default='0'>
-
Generate progressive jpeg images.
+
<attr name='jpeg-progressive=' value='0|1' default='0'>
<p>
+
Generate progressive jpeg images.
</p>
</attr>
-
<attr name='jpeg-smooth' value='0-100' default='0'>
+
<attr name='jpeg-smooth' value='0-100' default='0'>
<p>
Smooth the image while compressing it. This produces smaller files,
-
but might undo the effects of dithering.
+
but might undo the effects of dithering.
</p>
</attr>
-
<attr name='bmp-bpp' value='1,4,8,24' default='24'>
-
Force this number of bits per pixel for bmp images.
+
<attr name='bmp-bpp' value='1,4,8,24' default='24'>
<p>
+
Force this number of bits per pixel for bmp images.
</p>
</attr>
-
<attr name='bmp-windows' value='0|1' default='1'>
-
Windows or OS/2 mode, default is 1. (windows mode)
+
<attr name='bmp-windows' value='0|1' default='1'>
<p>
+
Windows or OS/2 mode, default is 1. (windows mode)
</p>
</attr>
-
<attr name='bmp-rle' value='0|1' default='0'>
-
RLE 'compress' the BMP image.
+
<attr name='bmp-rle' value='0|1' default='0'>
<p>
+
RLE 'compress' the BMP image.
</p>
</attr>
-
<attr name='gd-alpha_index' value='color' default='0'>
+
<attr name='gd-alpha_index' value='color' default='0'>
<p>
Color in the colormap to make transparent for GD-images with alpha
-
channel.
+
channel.
</p>
</attr>
-
<attr name='pcx-raw' value='1|0' default='0'>
-
If 1, do not RLE encode the PCX image.
+
<attr name='pcx-raw' value='1|0' default='0'>
<p>
+
If 1, do not RLE encode the PCX image.
</p>
</attr>
-
<attr name='pcx-dpy' value='0-10000000.0' default='75.0'>
-
Resolution, in pixels per inch.
+
<attr name='pcx-dpy' value='0-10000000.0' default='75.0'>
<p>
+
Resolution, in pixels per inch.
</p>
</attr>
-
<attr name='pcx-xdpy' value='0-10000000.0' default='75.0'>
-
Resolution, in pixels per inch.
+
<attr name='pcx-xdpy' value='0-10000000.0' default='75.0'>
<p>
+
Resolution, in pixels per inch.
</p>
</attr>
-
<attr name='pcx-ydpy' value='0-10000000.0' default='75.
-
Resolution, in pixels per inch.
+
<attr name='pcx-ydpy' value='0-10000000.0' default='75.
><p>
+
Resolution, in pixels per inch.
</p>
</attr>
-
<attr name='pcx-xoffset' value='0-imagexsize-2' default='0'>
+
<attr name='pcx-xoffset' value='0-imagexsize-2' default='0'>
<p>
Offset from start of image data to image content for PCX images.
-
Unused by most programs.
+
Unused by most programs.
</p>
</attr>
-
<attr name='pcx-yoffset' value='0-imageysize-2' default='0'>
+
<attr name='pcx-yoffset' value='0-imageysize-2' default='0'>
<p>
Offset from start of image data to image content for PCX images.
-
Unused by most programs.
+
Unused by most programs.
</p>
</attr>
-
<attr name='tga-raw' value='1|0' default='0'>
-
If 1, do not RLE encode the Targa image.
+
<attr name='tga-raw' value='1|0' default='0'>
<p>
+
If 1, do not RLE encode the Targa image.
</p>
</attr>
-
<attr name='ps-dpi' value='0-10000000.0' default='75.0'>
-
Dots per inch for the resulting postscript file.
+
<attr name='ps-dpi' value='0-10000000.0' default='75.0'>
<p>
+
Dots per inch for the resulting postscript file.
</p>
</attr>