From 9bb88c610f69f24ed213ceb026a2e1acc3b71f2d Mon Sep 17 00:00:00 2001 From: Lukas Kahwe Smith Date: Tue, 30 Mar 2021 09:12:34 +0200 Subject: [PATCH 1/2] lower case dependency names --- composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/composer.json b/composer.json index 2b16aa97c..f96c1a33d 100644 --- a/composer.json +++ b/composer.json @@ -19,7 +19,7 @@ }, "require": { "php": "^5.3.9|^7.0", - "imagine/Imagine": "^0.6.3|^0.7.0,<0.8", + "imagine/imagine": "^0.6.3|^0.7.0,<0.8", "symfony/asset": "~2.3|~3.0", "symfony/filesystem": "~2.3|~3.0", "symfony/finder": "~2.3|~3.0", From 1525914de40afeb09e83ffc123d5d81fc75f10a1 Mon Sep 17 00:00:00 2001 From: Lukas Kahwe Smith Date: Sat, 3 Apr 2021 11:22:49 +0200 Subject: [PATCH 2/2] [Doc] Simplified the strong role, follow up for, #1361 --- Resources/doc/filters/general.rst | 24 ++++++++-------- Resources/doc/filters/orientation.rst | 6 ++-- Resources/doc/filters/sizing.rst | 30 ++++++++++---------- Resources/doc/post-processors/jpeg-moz.rst | 4 +-- Resources/doc/post-processors/jpeg-optim.rst | 16 +++++------ Resources/doc/post-processors/png-opti.rst | 12 ++++---- Resources/doc/post-processors/png-quant.rst | 4 +-- 7 files changed, 48 insertions(+), 48 deletions(-) diff --git a/Resources/doc/filters/general.rst b/Resources/doc/filters/general.rst index 541b2b5f6..c3eb3866b 100644 --- a/Resources/doc/filters/general.rst +++ b/Resources/doc/filters/general.rst @@ -49,14 +49,14 @@ Example configuration: Background Options ~~~~~~~~~~~~~~~~~~ -:strong:`color:` ``string`` +**color:** ``string`` Sets the background color HEX value. The default color is white (``#fff``). -:strong:`size:` ``int[]`` +**size:** ``int[]`` Sets the generated background size as an integer array containing the dimensions as width and height values. -:strong:`position:` ``string`` +**position:** ``string`` Sets the position of the input image on the newly created background image. Valid values: ``topleft``, ``top``, ``topright``, ``left``, ``center``, ``right``, ``bottomleft``, ``bottom``, and ``bottomright``. @@ -122,7 +122,7 @@ Example configuration: Interlace Options ~~~~~~~~~~~~~~~~~ -:strong:`mode:` ``string`` +**mode:** ``string`` Sets the interlace mode to encode the file with. Valid values: ``none``, ``line``, ``plane``, and ``partition``. @@ -182,22 +182,22 @@ Example configuration: Resample Options ~~~~~~~~~~~~~~~~ -:strong:`unit:` ``string`` +**unit:** ``string`` Sets the unit to use for pixel density, either "pixels per inch" or "pixels per centimeter". Valid values: ``ppi`` and ``ppc``. -:strong:`x:` ``int|float`` +**x:** ``int|float`` Sets the horizontal (x) pixel density to resample the image to. -:strong:`y:` ``int|float`` +**y:** ``int|float`` Sets the vertical (y) pixel density to resample the image to. -:strong:`filter:` ``string`` +**filter:** ``string`` Sets the optional filter to use during the resampling operation. It must be a string resolvable as a constant from `Imagine\Image\ImageInterface`_ (you may omit the ``FILTER_`` prefix) or a valid fully qualified constant. By default it is set to ``FILTER_UNDEFINED``. -:strong:`tmp_dir:` ``string`` +**tmp_dir:** ``string`` Sets the optional temporary work directory. This filter requires a temporary location to save out and read back in the image binary, as these operations are requires to resample an image. By default, it is set to the value of the `sys_get_temp_dir()`_ function. @@ -270,15 +270,15 @@ Example configuration: Watermark Options ~~~~~~~~~~~~~~~~~ -:strong:`image:` ``string`` +**image:** ``string`` Sets the location of the watermark image. The value of this option is prepended with the resolved value of the ``%kernel.root_dir%`` parameter. -:strong:`size:` ``float`` +**size:** ``float`` Sets the size of the watermark as a relative ration, relative to the original input image. -:strong:`position:` ``string`` +**position:** ``string`` Sets the position of the watermark on the input image. Valid values: ``topleft``, ``top``, ``topright``, ``left``, ``centerleft``, ``center``, ``centerright``, ``right``, ``bottomleft``, ``bottom``, and ``bottomright``. diff --git a/Resources/doc/filters/orientation.rst b/Resources/doc/filters/orientation.rst index 2fd883ce7..c38bde268 100644 --- a/Resources/doc/filters/orientation.rst +++ b/Resources/doc/filters/orientation.rst @@ -65,7 +65,7 @@ Example configuration: Rotate Options ~~~~~~~~~~~~~~ -:strong:`degree:` ``float`` +**degree:** ``float`` Sets the "rotation angle" that defines the degree to rotate the image. Must be a positive number. @@ -102,10 +102,10 @@ Example configuration: Flip Options ~~~~~~~~~~~~ -:strong:`axis:` ``string`` +**axis:** ``string`` Sets the "flip axis" that defines the axis on which to flip the image. Valid values: ``x``, ``horizontal``, ``y``, ``vertical``. .. _`BoxInterface`: http://imagine.readthedocs.io/en/latest/usage/coordinates.html#boxinterface -.. _`Imagine Library`: http://imagine.readthedocs.io/en/latest/ \ No newline at end of file +.. _`Imagine Library`: http://imagine.readthedocs.io/en/latest/ diff --git a/Resources/doc/filters/sizing.rst b/Resources/doc/filters/sizing.rst index 04061a560..a7738831e 100644 --- a/Resources/doc/filters/sizing.rst +++ b/Resources/doc/filters/sizing.rst @@ -45,15 +45,15 @@ Example configuration: Thumbnail Options ~~~~~~~~~~~~~~~~~ -:strong:`mode:` ``string`` +**mode:** ``string`` Sets the desired resize method: ``'outbound'`` crops the image as required, while ``'inset'`` performs a non-cropping relative resize. -:strong:`size:` ``int[]`` +**size:** ``int[]`` Sets the generated thumbnail size as an integer array containing the dimensions as width and height values. -:strong:`allow_upscale:` ``bool`` +**allow_upscale:** ``bool`` Toggles allowing image up-scaling when the image is smaller than the desired thumbnail size. @@ -93,11 +93,11 @@ Example configuration: Crop Options ~~~~~~~~~~~~ -:strong:`size:` ``int[]`` +**size:** ``int[]`` Sets the crop size as an integer array containing the dimensions as width and height values. -:strong:`start:` ``int[]`` +**start:** ``int[]`` Sets the top, left-post anchor coordinates where the crop operation starts. @@ -169,19 +169,19 @@ Example configuration: Relative Resize Options ~~~~~~~~~~~~~~~~~~~~~~~ -:strong:`heighten:` ``float`` +**heighten:** ``float`` Sets the "desired height" which initiates a proportional scale operation that up- or down-scales until the image height matches this value. -:strong:`widen:` ``float`` +**widen:** ``float`` Sets the "desired width" which initiates a proportional scale operation that up- or down-scales until the image width matches this value. -:strong:`increase:` ``float`` +**increase:** ``float`` Sets the "desired additional size" which initiates a scale operation computed by adding this value to all image sides. -:strong:`scale:` ``float`` +**scale:** ``float`` Sets the "ratio multiple" which initiates a proportional scale operation computed by multiplying all image sides by this value. @@ -248,11 +248,11 @@ Example configuration: Scale Options ~~~~~~~~~~~~~ -:strong:`dim:` ``int[]`` +**dim:** ``int[]`` Sets the "desired dimensions" as an array containing a width and height integer, from which a relative resize is performed within these constraints. -:strong:`to:` ``float`` +**to:** ``float`` Sets the "ratio multiple" which initiates a proportional scale operation computed by multiplying all image sides by this value. @@ -299,11 +299,11 @@ Example configuration: Down Scale Options ~~~~~~~~~~~~~~~~~~ -:strong:`max:` ``int[]`` +**max:** ``int[]`` Sets the "desired max dimensions" as an array containing a width and height integer, from which a down-scale is performed to meet the passed constraints. -:strong:`by:` ``float`` +**by:** ``float`` Sets the "ratio multiple" which initiates a proportional scale operation computed by multiplying all image sides by this value. @@ -350,11 +350,11 @@ Example configuration: Up Scale Options ~~~~~~~~~~~~~~~~ -:strong:`min:` ``int[]`` +**min:** ``int[]`` Sets the "desired min dimensions" as an array containing a width and height integer, from which an up-scale is performed to meet the passed constraints. -:strong:`by:` ``float`` +**by:** ``float`` Sets the "ratio multiple" which initiates a proportional scale operation computed by multiplying all image sides by this value. diff --git a/Resources/doc/post-processors/jpeg-moz.rst b/Resources/doc/post-processors/jpeg-moz.rst index 9857674ab..08e1cfd5b 100644 --- a/Resources/doc/post-processors/jpeg-moz.rst +++ b/Resources/doc/post-processors/jpeg-moz.rst @@ -40,12 +40,12 @@ This configuration sets a maximum quality factor of 70 for the resulting image b Options ------- -:strong:`quality:` ``int`` +**quality:** ``int`` Sets the image quality factor. Parameters ---------- -:strong:`liip_imagine.mozjpeg.binary:` ``string`` +**liip_imagine.mozjpeg.binary:** ``string`` Sets the location of the ``cjpeg`` executable. Default is ``/opt/mozjpeg/bin/cjpeg``. diff --git a/Resources/doc/post-processors/jpeg-optim.rst b/Resources/doc/post-processors/jpeg-optim.rst index b125fa7a8..9733ac64f 100644 --- a/Resources/doc/post-processors/jpeg-optim.rst +++ b/Resources/doc/post-processors/jpeg-optim.rst @@ -42,32 +42,32 @@ a maximum quality factor of 70 for the resulting image binary. Options ------- -:strong:`strip_all:` ``bool`` +**strip_all:** ``bool`` Removes all comments, EXIF markers, and other image metadata. -:strong:`max:` ``int`` +**max:** ``int`` Sets the maximum image quality factor. -:strong:`progressive:` ``bool`` +**progressive:** ``bool`` Ensures the image uses progressive encoding. Parameters ---------- -:strong:`liip_imagine.jpegoptim.stripAll:` ``bool`` +**liip_imagine.jpegoptim.stripAll:** ``bool`` Removes all comments, EXIF markers, and other metadata from the image binary. -:strong:`liip_imagine.jpegoptim.max:` ``int`` +**liip_imagine.jpegoptim.max:** ``int`` Assigns the maximum quality factor for the image binary. -:strong:`liip_imagine.jpegoptim.progressive:` ``bool`` +**liip_imagine.jpegoptim.progressive:** ``bool`` Ensures that progressive encoding is enabled for the image binary. -:strong:`liip_imagine.jpegoptim.binary:` ``string`` +**liip_imagine.jpegoptim.binary:** ``string`` Sets the location of the ``jpegoptim`` executable. Default is ``/usr/bin/jpegoptim``. -:strong:`liip_imagine.jpegoptim.tempDir:` ``string`` +**liip_imagine.jpegoptim.tempDir:** ``string`` Sets the directory to store temporary files. diff --git a/Resources/doc/post-processors/png-opti.rst b/Resources/doc/post-processors/png-opti.rst index 0e884e22f..837cc72ef 100644 --- a/Resources/doc/post-processors/png-opti.rst +++ b/Resources/doc/post-processors/png-opti.rst @@ -42,26 +42,26 @@ for the resulting image binary. Options ------- -:strong:`strip_all:` ``bool`` +**strip_all:** ``bool`` Removes all comments, EXIF markers, and other image metadata. -:strong:`level:` ``int`` +**level:** ``int`` Sets the image optimization factor. Parameters ---------- -:strong:`liip_imagine.optipng.stripAll:` ``bool`` +**liip_imagine.optipng.stripAll:** ``bool`` Removes all comments, EXIF markers, and other metadata from the image binary. -:strong:`liip_imagine.optipng.level:` ``int`` +**liip_imagine.optipng.level:** ``int`` Sets the image optimization factor. Default is ``7``. -:strong:`liip_imagine.optipng.binary:` ``string`` +**liip_imagine.optipng.binary:** ``string`` Sets the location of the ``optipng`` executable. Default is ``/usr/bin/optipng``. -:strong:`liip_imagine.optipng.tempDir:` ``string`` +**liip_imagine.optipng.tempDir:** ``string`` Sets the directory to store temporary files. diff --git a/Resources/doc/post-processors/png-quant.rst b/Resources/doc/post-processors/png-quant.rst index 61c3431f5..2e506fea6 100644 --- a/Resources/doc/post-processors/png-quant.rst +++ b/Resources/doc/post-processors/png-quant.rst @@ -41,12 +41,12 @@ This configuration sets a quality factor range of 75 to 80 for the resulting ima Options ------- -:strong:`quality:` ``int`` +**quality:** ``int`` Sets the image optimization factor. Parameters ---------- -:strong:`liip_imagine.pngquant.binary:` ``string`` +**liip_imagine.pngquant.binary:** ``string`` Sets the location of the ``pnquant`` executable. Default is ``/usr/bin/pnquant``.