Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding documentation for new parameters. #1

Merged
merged 1 commit into from
Jul 21, 2016
Merged

Adding documentation for new parameters. #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 33 additions & 2 deletions Resources/doc/filters.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,9 +381,26 @@ parameters, for example:

.. _`Symfony Service Container`: http://symfony.com/doc/current/book/service_container.html

It is also possible to configure other defaults for the conversion process via parameters,
for example:

The ``OptiPngPostProcessor`` is also available by default and can be used just as jpegoptim.
Make sure that optipng binary is installed on the system and change the
.. code-block:: yaml

parameters:
# When true, this passes down --strip-all to jpegoptim, which strips all markers from the output jpeg.
liip_imagine.jpegoptim.stripAll: true

# Sets the maxiumum image quality factor.
liip_imagine.jpegoptim.max: null

# When true, --all-progressive is passed to jpegoptim, which results in the output being a progressive jpeg.
liip_imagine.jpegoptim.progressive: true

.. _`Symfony Service Container`: http://symfony.com/doc/current/book/service_container.html


The ``OptiPngPostProcessor`` is also available by default and can be used just as jpegoptim.
Make sure that optipng binary is installed on the system and change the
``liip_imagine.optipng.binary`` in parameters if needed.

.. code-block:: yaml
Expand All @@ -392,3 +409,17 @@ Make sure that optipng binary is installed on the system and change the
liip_imagine.optipng.binary: /usr/local/bin/optipng

.. _`Symfony Service Container`: http://symfony.com/doc/current/book/service_container.html

It is also possible to configure other defaults for the conversion process via parameters,
for example:

.. code-block:: yaml

parameters:
# When true, this passes down --strip=all to optipng, which removes all metadata from the output image.
liip_imagine.optipng.stripAll: true

# The optimisation level to be used by optipng. Defaults to 7.
liip_imagine.optipng.level: 7

.. _`Symfony Service Container`: http://symfony.com/doc/current/book/service_container.html