From bf85f00b35690c8291628fd44f478bf866ee3e8a Mon Sep 17 00:00:00 2001 From: Stepan Anchugov Date: Tue, 27 Oct 2015 22:33:24 +0500 Subject: [PATCH] Incorporate feedback from @WouterJ --- Resources/doc/basic-usage.rst | 80 ++++++++++++++++++----------------- 1 file changed, 41 insertions(+), 39 deletions(-) diff --git a/Resources/doc/basic-usage.rst b/Resources/doc/basic-usage.rst index 69645d886..422ad206e 100644 --- a/Resources/doc/basic-usage.rst +++ b/Resources/doc/basic-usage.rst @@ -9,7 +9,6 @@ you want to thumbnail an image to a size of 120x90 pixels: .. code-block:: yaml # app/config/config.yml - liip_imagine: resolvers: default: @@ -22,22 +21,22 @@ you want to thumbnail an image to a size of 120x90 pixels: filters: thumbnail: { size: [120, 90], mode: outbound } -You've now defined a filter set called `my_thumb` that performs a thumbnail transformation. -We'll learn more about available transformations later, but for now, this -new filter can be used immediately in a template: +You've now defined a filter set called `my_thumb` that performs a thumbnail +transformation. We'll learn more about available transformations later, but +for now, this new filter can be used immediately in a template: -.. code-block:: jinja +.. configuration-block: - + .. code-block:: html+jinja -Or if you're using PHP templates: + -.. code-block:: php - - + .. code-block:: html+php -Behind the scenes, the bundles applies the filter(s) to the image on the first -request and then caches the image to a similar path. On the next request, + + +Behind the scenes, the bundles applies the filter(s) to the image on the +first request and then caches the image to a similar path. On the next request, the cached image would be served directly from the file system. In this example, the final rendered path would be something like @@ -46,32 +45,33 @@ would save the filtered image file. You can also pass some options at runtime: -.. code-block:: jinja +.. configuration-block: - {% set runtimeConfig = {"thumbnail": {"size": [50, 50] }} %} - + .. code-block:: html+jinja -Or if you're using PHP templates: + {% set runtimeConfig = {"thumbnail": {"size": [50, 50] }} %} + -.. code-block:: php + .. code-block:: html+php - array( - "size" => array(50, 50) - ) - ); - ?> + array( + "size" => array(50, 50) + ) + ); + ?> - + Also you can resolve image url from console: -.. code-block:: jinja +.. code-block:: bash - app/console liip:imagine:cache:resolve relative/path/to/image.jpg relative/path/to/image2.jpg --filters=my_thumb --filters=thumbnail_default + $ php app/console liip:imagine:cache:resolve relative/path/to/image.jpg relative/path/to/image2.jpg --filters=my_thumb --filters=thumbnail_default -Where only paths required parameter. They are separated by space. If you omit filters option will be applied all available filters. +Where only paths required parameter. They are separated by space. If you +omit filters option will be applied all available filters. If you need to access filtered image URL in your controller: @@ -79,16 +79,18 @@ If you need to access filtered image URL in your controller: $this->get('liip_imagine.cache.manager')->getBrowserPath('/relative/path/to/image.jpg', 'my_thumb', true), -In this case, the final rendered path would contain some random data in the path -`/media/cache/my_thumb/S8rrlhhQ/relative/path/to/image.jpg`. This is where Imagine -would save the filtered image file. +In this case, the final rendered path would contain some random data in the +path ``/media/cache/my_thumb/S8rrlhhQ/relative/path/to/image.jpg``. This is where +Imagine would save the filtered image file. .. note:: - Using the ``dev`` environment you might find that the images are not properly rendered when - using the template helper. This is likely caused by having ``intercept_redirect`` enabled in your - application configuration. To ensure that the images are rendered disable this option: - - .. code-block:: jinja - - web_profiler: - intercept_redirects: false + + Using the ``dev`` environment you might find that the images are not properly + rendered when using the template helper. This is likely caused by having ` + `intercept_redirect`` enabled in your application configuration. To ensure + that the images are rendered disable this option: + +.. code-block:: yaml + + web_profiler: + intercept_redirects: false