Skip to content

Commit 139f816

Browse files
committed
changed RST single backtick to double
1 parent eed42b7 commit 139f816

28 files changed

+261
-289
lines changed

Diff for: Resources/doc/basic-usage.rst

+18-19
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11

2-
.. default-role:: code
32

43
Basic Usage
54
===========
65

76
Generally, this bundle works by applying filter sets to images from inside
87
a template. Your filter sets are defined within the application's configuration
9-
file (often `app/config/config.yml`) and are comprised of a collection of
8+
file (often ``app/config/config.yml``) and are comprised of a collection of
109
filters, post-processors, and other optional parameters.
1110

1211
We'll learn more about post-processors and other available parameters later,
@@ -52,7 +51,7 @@ to have the following transformations applied to them:
5251
* Adjust the image quality to 75.
5352

5453
Adding onto our boilerplate from above, we need to define a filter set (which we'll
55-
name `my_thumb`) with two filters configured: the `thumbnail` and `background`
54+
name ``my_thumb``) with two filters configured: the ``thumbnail`` and ``background``
5655
filters.
5756

5857
.. code-block:: yaml
@@ -84,10 +83,10 @@ filters.
8483
# 4px larger to create a 2px border around the final image
8584
background: { size: [124, 94], position: center, color: '#000000' }
8685
87-
You've now created a filter set called `my_thumb` that performs a thumbnail
88-
transformation. The `thumbnail` filter sizes the image to the desired width
89-
and height (120x90px), and its `mode: outbound` option causes
90-
the resulting image to be cropped if the input ratio differs. The `background`
86+
You've now created a filter set called ``my_thumb`` that performs a thumbnail
87+
transformation. The ``thumbnail`` filter sizes the image to the desired width
88+
and height (120x90px), and its ``mode: outbound`` option causes
89+
the resulting image to be cropped if the input ratio differs. The ``background``
9190
filter results in a 2px black border by creating a black canvas 124x94px in size,
9291
and positioning the thumbnail at its center.
9392

@@ -98,7 +97,7 @@ and positioning the thumbnail at its center.
9897
transformations can have any number of filters defined for them.
9998

10099
There are a number of additional :doc:`filters <filters>`, but for now you can use
101-
your newly defined `my_thumb` filter set immediately within a template.
100+
your newly defined ``my_thumb`` filter set immediately within a template.
102101

103102
.. configuration-block::
104103

@@ -113,13 +112,13 @@ your newly defined `my_thumb` filter set immediately within a template.
113112
Behind the scenes, the bundle applies the filter(s) to the image on-the-fly
114113
when the first page request is served. The transformed image is then cached
115114
for subsequent requests. The final cached image path would be similar to
116-
`/media/cache/my_thumb/relative/path/to/image.jpg`.
115+
``/media/cache/my_thumb/relative/path/to/image.jpg``.
117116

118117
.. note::
119118

120-
Using the `dev` environment you might find that images are not properly
119+
Using the ``dev`` environment you might find that images are not properly
121120
rendered via the template helper. This is often caused by having
122-
`intercept_redirect` enabled in your application configuration. To ensure
121+
``intercept_redirect`` enabled in your application configuration. To ensure
123122
images are rendered, it is strongly suggested to disable this option:
124123

125124
.. code-block:: yaml
@@ -171,15 +170,15 @@ Resolve with the Console
171170
~~~~~~~~~~~~~~~~~~~~~~~~
172171

173172
You can resolve an image URL using the console command
174-
`liip:imagine:cache:resolve`. The only required argument is one or more
173+
``liip:imagine:cache:resolve``. The only required argument is one or more
175174
relative image paths (which must be separated by a space).
176175

177176
.. code-block:: bash
178177
179178
$ php app/console liip:imagine:cache:resolve relative/path/to/image1.jpg relative/path/to/image2.jpg
180179
181-
Additionally, you can use the `--filters` option to specify which filter
182-
you want to resolve for (if the `--filters` option is omitted, all
180+
Additionally, you can use the ``--filters`` option to specify which filter
181+
you want to resolve for (if the ``--filters`` option is omitted, all
183182
available filters will be resolved).
184183

185184
.. code-block:: bash
@@ -190,9 +189,9 @@ available filters will be resolved).
190189
Resolve Pragmatically
191190
~~~~~~~~~~~~~~~~~~~~~
192191

193-
You can resolve the image URL in your code using the `getBrowserPath`
194-
method of the `liip_imagine.cache.manager` service. Assuming you already
195-
have the service assigned to a variable called `$imagineCacheManager`,
192+
You can resolve the image URL in your code using the ``getBrowserPath``
193+
method of the ``liip_imagine.cache.manager`` service. Assuming you already
194+
have the service assigned to a variable called ``$imagineCacheManager``,
196195
you would run:
197196

198197
.. code-block:: php
@@ -201,8 +200,8 @@ you would run:
201200
202201
Often, you need to perform this operation in a controller. Assuming your
203202
controller inherits from the base Symfony controller, you can take advantage
204-
of the inherited `get` method to request the `liip_imagine.cache.manager`
205-
service, from which you can call `getBrowserPath` on a relative image
203+
of the inherited ``get`` method to request the ``liip_imagine.cache.manager``
204+
service, from which you can call ``getBrowserPath`` on a relative image
206205
path to get its resolved location.
207206

208207
.. code-block:: php

Diff for: Resources/doc/cache-manager.rst

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11

2-
.. default-role:: code
32

43
Cache Manager
54
=============

Diff for: Resources/doc/cache-resolver/amazons3.rst

+4-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11

2-
.. default-role:: code
32
.. _cache-resolver-amazon-s3:
43

54
Amazon S3 Resolver
65
==================
76

8-
The `AmazonS3Resolver` resolver enables cache resolution using Amazon S3.
7+
The ``AmazonS3Resolver`` resolver enables cache resolution using Amazon S3.
98

109
Dependencies
1110
------------
@@ -65,8 +64,8 @@ Next, you must define the required services.
6564
Usage
6665
-----
6766

68-
After configuring `AmazonS3Resolver`, you can set it as the default cache resolver
69-
for `LiipImagineBundle` using the following configuration.
67+
After configuring ``AmazonS3Resolver``, you can set it as the default cache resolver
68+
for ``LiipImagineBundle`` using the following configuration.
7069

7170
.. code-block:: yaml
7271
@@ -79,7 +78,7 @@ for `LiipImagineBundle` using the following configuration.
7978
Usage on a Specific Filter
8079
~~~~~~~~~~~~~~~~~~~~~~~~~~
8180

82-
Alternatively, you can set `AmazonS3Resolver` as the cache resolver for a specific
81+
Alternatively, you can set ``AmazonS3Resolver`` as the cache resolver for a specific
8382
filter set using the following configuration.
8483

8584
.. code-block:: yaml

Diff for: Resources/doc/cache-resolver/aws_s3.rst

+13-14
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11

2-
.. default-role:: code
32
.. _cache-resolver-aws-s3:
43

54
AWS S3 Resolver
65
===============
76

8-
The `AwsS3Resolver` resolver enables cache resolution using Amazon S3.
7+
The ``AwsS3Resolver`` resolver enables cache resolution using Amazon S3.
98

109

1110
Dependencies
@@ -69,8 +68,8 @@ Create Resolver from a Factory
6968
7069
.. tip::
7170

72-
If using `aws-sdk-php`_ < `3.0.0`, you must omit the `credentials` key and instead
73-
place the `key` and `secret` keys at the same level as `region` and `bucket`.
71+
If using `aws-sdk-php`_ < ``3.0.0``, you must omit the ``credentials`` key and instead
72+
place the ``key`` and ``secret`` keys at the same level as ``region`` and ``bucket``.
7473

7574
.. code-block:: yaml
7675
@@ -117,8 +116,8 @@ You have to set up the services required:
117116
118117
.. tip::
119118

120-
If using `aws-sdk-php`_ < `3.0.0`, you must omit the `credentials` key and instead
121-
place the `key` and `secret` keys at the same level as `region` and `bucket`.
119+
If using `aws-sdk-php`_ < ``3.0.0``, you must omit the ``credentials`` key and instead
120+
place the ``key`` and ``secret`` keys at the same level as ``region`` and ``bucket``.
122121

123122
.. code-block:: yaml
124123
@@ -137,8 +136,8 @@ You have to set up the services required:
137136
Usage
138137
-----
139138

140-
After configuring `AwsS3Resolver`, you can set it as the default cache resolver
141-
for `LiipImagineBundle` using the following configuration.
139+
After configuring ``AwsS3Resolver``, you can set it as the default cache resolver
140+
for ``LiipImagineBundle`` using the following configuration.
142141

143142
.. code-block:: yaml
144143
@@ -151,7 +150,7 @@ for `LiipImagineBundle` using the following configuration.
151150
Usage on a Specific Filter
152151
~~~~~~~~~~~~~~~~~~~~~~~~~~
153152

154-
Alternatively, you can set `AmazonS3Resolver` as the cache resolver for a specific
153+
Alternatively, you can set ``AmazonS3Resolver`` as the cache resolver for a specific
155154
filter set using the following configuration.
156155

157156
.. code-block:: yaml
@@ -247,11 +246,11 @@ for the list of available options.
247246
Note, that the following options are configured automatically and will be
248247
ignored, even if you configure it via ObjectOptions:
249248

250-
* `ACL`
251-
* `Bucket`
252-
* `Key`
253-
* `Body`
254-
* `ContentType`
249+
* ``ACL``
250+
* ``Bucket``
251+
* ``Key``
252+
* ``Body``
253+
* ``ContentType``
255254

256255

257256
In order to make use of the object PUT options, you can simply add a call to the

Diff for: Resources/doc/cache-resolver/cache.rst

+8-9
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11

2-
.. default-role:: code
32
.. _cache-resolver-cache:
43

54
Cache Resolver
65
==============
76

8-
The `CacheResolver` cannot be used by itself. Instead, it is a "wrapper" for
7+
The ``CacheResolver`` cannot be used by itself. Instead, it is a "wrapper" for
98
another resolver.
109

1110

@@ -28,7 +27,7 @@ Configuration
2827
-------------
2928

3029
First, you need to setup the required services. In this example we're wrapping an
31-
instance of `AmazonS3Resolver` inside this resolver.
30+
instance of ``AmazonS3Resolver`` inside this resolver.
3231

3332
.. code-block:: yaml
3433
@@ -69,19 +68,19 @@ instance of `AmazonS3Resolver` inside this resolver.
6968
7069
There are three options available:
7170

72-
* `global_prefix`: A prefix for all keys within the cache. This is useful to
71+
* ``global_prefix``: A prefix for all keys within the cache. This is useful to
7372
avoid colliding keys when using the same cache for different systems.
74-
* `prefix`: A "local" prefix for this wrapper. This is useful when re-using the
73+
* ``prefix``: A "local" prefix for this wrapper. This is useful when re-using the
7574
same resolver for multiple filters. This mainly affects the clear method.
76-
* `index_key`: The name of the index key being used to save a list of created
75+
* ``index_key``: The name of the index key being used to save a list of created
7776
cache keys regarding one image and filter pairing.
7877

7978

8079
Usage
8180
-----
8281

83-
After configuring `CacheResolver`, you can set it as the default cache resolver
84-
for `LiipImagineBundle` using the following configuration.
82+
After configuring ``CacheResolver``, you can set it as the default cache resolver
83+
for ``LiipImagineBundle`` using the following configuration.
8584

8685
.. code-block:: yaml
8786
@@ -94,7 +93,7 @@ for `LiipImagineBundle` using the following configuration.
9493
Usage on a Specific Filter
9594
~~~~~~~~~~~~~~~~~~~~~~~~~~
9695

97-
Alternatively, you can set `CacheResolver` as the cache resolver for a specific
96+
Alternatively, you can set ``CacheResolver`` as the cache resolver for a specific
9897
filter set using the following configuration.
9998

10099
.. code-block:: yaml

Diff for: Resources/doc/cache-resolver/flysystem.rst

+13-14
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11

2-
.. default-role:: code
32
.. _cache-resolver-flysystem:
43

54
Flysystem Resolver
65
==================
76

8-
The `FlysystemResolver` resolver enabled cache resolution using the `Flysystem`_
7+
The ``FlysystemResolver`` resolver enabled cache resolution using the `Flysystem`_
98
filesystem abstraction layer.
109

1110
Dependencies
@@ -26,8 +25,8 @@ can be installed by executing the following command in your project directory:
2625
Configuration
2726
-------------
2827

29-
The value of the `filesystem_service` property must be a service that returns an
30-
instance of `League\\Flysystem\\Filesystem`.
28+
The value of the ``filesystem_service`` property must be a service that returns an
29+
instance of ``League\\Flysystem\\Filesystem``.
3130

3231
The following implementation uses `OneupFlysystemBundle`_.
3332

@@ -56,24 +55,24 @@ The following implementation uses `OneupFlysystemBundle`_.
5655
5756
There are several configuration options available:
5857

59-
* `root_url`: must be a valid url to the target system the flysystem adapter
58+
* ``root_url``: must be a valid url to the target system the flysystem adapter
6059
points to. This is used to determine how the url should be generated upon request.
61-
Default value: `null`
62-
* `cache_prefix`: this is used for the image path generation. This will be the
60+
Default value: ``null``
61+
* ``cache_prefix``: this is used for the image path generation. This will be the
6362
prefix inside the given Flysystem.
64-
Default value: `media/cache`
65-
* `visibility`: one of the two predefined flysystem visibility constants
66-
(`AdapterInterface::VISIBILITY_PUBLIC` [`public`] / `AdapterInterface::VISIBILITY_PRIVATE` [`private`])
63+
Default value: ``media/cache``
64+
* ``visibility``: one of the two predefined flysystem visibility constants
65+
(``AdapterInterface::VISIBILITY_PUBLIC`` [``public``] / ``AdapterInterface::VISIBILITY_PRIVATE`` [``private``])
6766
The visibility is applied, when the objects are stored on a flysystem filesystem.
68-
You will most probably want to leave the default or explicitly set `public`.
69-
Default value: `public`
67+
You will most probably want to leave the default or explicitly set ``public``.
68+
Default value: ``public``
7069

7170

7271
Usage
7372
-----
7473

75-
After configuring `FlysystemResolver`, you can set it as the default cache resolver
76-
for `LiipImagineBundle` using the following configuration.
74+
After configuring ``FlysystemResolver``, you can set it as the default cache resolver
75+
for ``LiipImagineBundle`` using the following configuration.
7776

7877
.. code-block:: yaml
7978

Diff for: Resources/doc/cache-resolver/proxy.rst

+7-8
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11

2-
.. default-role:: code
32
.. _cache-resolver-proxy:
43

54
ProxyResolver
65
=============
76

8-
The `ProxyResolver` cannot be used by itself. Instead, it is a "decorator" for
7+
The ``ProxyResolver`` cannot be used by itself. Instead, it is a "decorator" for
98
another resolver. It add the ability to use "Proxy Hosts" for your assets. If no
109
"Proxy Domains" are set, it behaves like the underlying cache resolver.
1110

@@ -35,16 +34,16 @@ and the cache resolver service to decorate.
3534
- { name: "liip_imagine.cache.resolver", resolver: "proxy" }
3635
3736
With this configuration, the cache resolver will generate paths such as
38-
`//images0.domain.com/.../image.jpg`, `//images1.domain.com/.../image.jpg`, and
39-
`//images2.domain.com/.../image.jpg` (instead of the original path
37+
``//images0.domain.com/.../image.jpg``, ``//images1.domain.com/.../image.jpg``, and
38+
``//images2.domain.com/.../image.jpg`` (instead of the original path
4039
returned from the decorated cache resolver, in this example using AWS,
41-
`//bucket.s3.awsamazoncloud.com/.../image.jpg`).
40+
``//bucket.s3.awsamazoncloud.com/.../image.jpg``).
4241

4342
Usage
4443
-----
4544

46-
After configuring `ProxyResolver`, you can set it as the default cache resolver
47-
for `LiipImagineBundle` using the following configuration.
45+
After configuring ``ProxyResolver``, you can set it as the default cache resolver
46+
for ``LiipImagineBundle`` using the following configuration.
4847

4948
.. code-block:: yaml
5049
@@ -57,7 +56,7 @@ for `LiipImagineBundle` using the following configuration.
5756
Usage on a Specific Filter
5857
~~~~~~~~~~~~~~~~~~~~~~~~~~
5958

60-
Alternatively, you can set `ProxyResolver` as the cache resolver for a specific
59+
Alternatively, you can set ``ProxyResolver`` as the cache resolver for a specific
6160
filter set using the following configuration.
6261

6362
.. code-block:: yaml

0 commit comments

Comments
 (0)