image.ini [ImageMagick] #

The block [ImageMagick] of settings/image.ini, with 14 setting(s).

The following filters are supported by GD
geometry/scale
geometry/scalewidth
geometry/scaleheight
geometry/scaledownonly
geometry/scalewidthdownonly
geometry/scaleheightdownonly
geometry/scaleexact
geometry/scalepercent
geometry/crop
colorspace/gray
luminance/gray
luminance/sepia
color/monochrome
border
border/color
border/width

Never edit settings/image.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/image.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/image.ini.append.php for one siteaccess,
• extension/<extension>/settings/image.ini.append.php in an extension (read when the extension is active).

Name #

Default: ImageMagick.

<?php /* #?ini charset="utf-8"?
# settings/override/image.ini.append.php
[ImageMagick]
Name=ImageMagick
*/ ?>

IsEnabled #

If set to true then this handler will be used,
The setup wizard will turn this off it ImageMagick is not found on the system

Default: true.

<?php /* #?ini charset="utf-8"?
# settings/override/image.ini.append.php
[ImageMagick]
IsEnabled=true
*/ ?>

Handler #

Which PHP handler to use for the conversion,
ezimageshell means to use the generic shell handler which
creates a command line and executes it with system().

Default: eZImageShellFactory.

<?php /* #?ini charset="utf-8"?
# settings/override/image.ini.append.php
[ImageMagick]
Handler=eZImageShellFactory
*/ ?>

ExecutablePath #

The path to the executable, can be empty for global path.

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/image.ini.append.php
[ImageMagick]
ExecutablePath=
*/ ?>

Executable #

Name of the executable

Default: convert.

<?php /* #?ini charset="utf-8"?
# settings/override/image.ini.append.php
[ImageMagick]
Executable=convert
*/ ?>

PreParameters #

Name of the executable for windows,
uncomment ExecutableMac for Mac specific converter and
ExecutableUnix for Unix/Linux specific converter
ExecutableWin32=convertim
ExecutableMac=convert
ExecutableUnix=convert
Parameters that must be run before the filenames and filters.

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/image.ini.append.php
[ImageMagick]
PreParameters=
*/ ?>

PostParameters #

Parameters that must be run after the filenames and filters.

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/image.ini.append.php
[ImageMagick]
PostParameters=
*/ ?>

UseTypeTag #

Whether the destination name should be prefixed with a TAG name (see MIMETagMap below)
The variable contains the separator between the TAG and the filename.
This is needed for ImageMagick to provide proper conversions of some formats.

Default: :.

<?php /* #?ini charset="utf-8"?
# settings/override/image.ini.append.php
[ImageMagick]
UseTypeTag=:
*/ ?>

InputMIMEList #

MIME types that the converter can get as input

Default: a list of 1: *.

<?php /* #?ini charset="utf-8"?
# settings/override/image.ini.append.php
[ImageMagick]
# an empty "InputMIMEList[]" first replaces the shipped list; without it the items are added
InputMIMEList[]
InputMIMEList[]=*
*/ ?>

OutputMIMEList #

MIME types that the converter can generate

Default: a list of 1: *.

<?php /* #?ini charset="utf-8"?
# settings/override/image.ini.append.php
[ImageMagick]
# an empty "OutputMIMEList[]" first replaces the shipped list; without it the items are added
OutputMIMEList[]
OutputMIMEList[]=*
*/ ?>

QualityParameters #

A list of mime types and their quality parameters

Default: a list of 1: image/jpeg;-quality %1.

<?php /* #?ini charset="utf-8"?
# settings/override/image.ini.append.php
[ImageMagick]
# an empty "QualityParameters[]" first replaces the shipped list; without it the items are added
QualityParameters[]
QualityParameters[]=image/jpeg;-quality %1
*/ ?>

FrameRangeParameters #

This setting will provide the possibility to postpend options to the source file filename.
This behavior is needed to address a specific layer in PSD files.
This array needs a semicolon seperated value which will build like this:
<mimetype>;<option>
Set frame range to handle PSD files with ImageMagick

Default: a list of 1: application/x-photoshop;[0].

<?php /* #?ini charset="utf-8"?
# settings/override/image.ini.append.php
[ImageMagick]
# an empty "FrameRangeParameters[]" first replaces the shipped list; without it the items are added
FrameRangeParameters[]
FrameRangeParameters[]=application/x-photoshop;[0]
*/ ?>

Filters #

A list of filter ImageMagick supports, add more if needed
The same filter names are used in aliases and MIME type overrides with optional parameters.
+repage: the cut image starts at 0,0, so a filter after it (another crop, a scale) works on what was cut

Default: a list of 19: geometry/scale=-geometry %1x%2, geometry/scalewidth=-geometry %1, geometry/scaleheight=-geometry x%1, geometry/scaledownonly=-geometry %1x%2>, geometry/scalewidthdownonly=-geometry %1>, geometry/scaleheightdownonly=-geometry x%1>, geometry/scaleexact=-geometry %1x%2!, geometry/scalepercent=-geometry %1x%2%, geometry/crop=-crop %1x%2+%3+%4 +repage, filter/noise=-noise %1, filter/swirl=-swirl %1, colorspace/gray=-colorspace GRAY ....

<?php /* #?ini charset="utf-8"?
# settings/override/image.ini.append.php
[ImageMagick]
# an empty "Filters[]" first replaces the shipped list; without it the items are added
Filters[]
Filters[]=geometry/scale=-geometry %1x%2
Filters[]=geometry/scalewidth=-geometry %1
Filters[]=geometry/scaleheight=-geometry x%1
Filters[]=geometry/scaledownonly=-geometry %1x%2>
Filters[]=geometry/scalewidthdownonly=-geometry %1>
Filters[]=geometry/scaleheightdownonly=-geometry x%1>
Filters[]=geometry/scaleexact=-geometry %1x%2!
Filters[]=geometry/scalepercent=-geometry %1x%2%
Filters[]=geometry/crop=-crop %1x%2+%3+%4 +repage
Filters[]=filter/noise=-noise %1
Filters[]=filter/swirl=-swirl %1
Filters[]=colorspace/gray=-colorspace GRAY
Filters[]=colorspace/transparent=-colorspace Transparent
Filters[]=colorspace=-colorspace %1
Filters[]=border=-border %1x%2
Filters[]=border/color=-bordercolor rgb(%1,%2,%3)
Filters[]=border/width=-borderwidth %1
Filters[]=flatten=-flatten
Filters[]=resize=-resize %1
*/ ?>

MIMETagMap #

Maps a MIME type to a tag name which is prepended to the destination name for ImageMagick

Default: a list of 19: image/x-xpixmap;XPM, image/png;PNG, image/webp;WEBP, image/jpeg;JPEG, image/bmp;BMP, image/gif;GIF, image/x-portable-bitmap;PBM, image/tiff;TIFF, image/pcx;PCX, image/x-pict;PICT, image/svg+xml;SVG, image/tga;TGA ....

<?php /* #?ini charset="utf-8"?
# settings/override/image.ini.append.php
[ImageMagick]
# an empty "MIMETagMap[]" first replaces the shipped list; without it the items are added
MIMETagMap[]
MIMETagMap[]=image/x-xpixmap;XPM
MIMETagMap[]=image/png;PNG
MIMETagMap[]=image/webp;WEBP
MIMETagMap[]=image/jpeg;JPEG
MIMETagMap[]=image/bmp;BMP
MIMETagMap[]=image/gif;GIF
MIMETagMap[]=image/x-portable-bitmap;PBM
MIMETagMap[]=image/tiff;TIFF
MIMETagMap[]=image/pcx;PCX
MIMETagMap[]=image/x-pict;PICT
MIMETagMap[]=image/svg+xml;SVG
MIMETagMap[]=image/tga;TGA
MIMETagMap[]=image/vnd.wap.wbmp;WBMP
MIMETagMap[]=image/x-xbitmap;XBM
MIMETagMap[]=image/x-xcf-gimp;XCF
MIMETagMap[]=application/x-photoshop;PSD
MIMETagMap[]=application/pdf;PDF
MIMETagMap[]=application/postscript;PS
MIMETagMap[]=text/plain;TEXT
*/ ?>

Related #

• All blocks of image.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/image.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.