Skip to content

Commit a0b1aeb

Browse files
committed
minor #98 Remove mentions of cookbook/book (WouterJ)
This PR was squashed before being merged into the 2.7 branch (closes #98). Discussion ---------- Remove mentions of cookbook/book Fixes #96 Commits ------- ca035f0 Remove mentions of cookbook/book
2 parents b56ae75 + ca035f0 commit a0b1aeb

File tree

95 files changed

+311
-366
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

95 files changed

+311
-366
lines changed

Diff for: assetic/apply_to_option.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ You can also combine multiple CoffeeScript files into a single output file:
114114

115115
Both files will now be served up as a single file compiled into regular JavaScript.
116116

117-
.. _cookbook-assetic-apply-to:
117+
.. _assetic-apply-to:
118118

119119
Filtering Based on a File Extension
120120
-----------------------------------

Diff for: assetic/asset_management.rst

+17-17
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
How to Use Assetic for Asset Management
55
=======================================
66

7-
Assetic combines two major ideas: :ref:`assets <cookbook-assetic-assets>` and
8-
:ref:`filters <cookbook-assetic-filters>`. The assets are files such as CSS,
7+
Assetic combines two major ideas: :ref:`assets <assetic-assets>` and
8+
:ref:`filters <assetic-filters>`. The assets are files such as CSS,
99
JavaScript and image files. The filters are things that can be applied to
1010
these files before they are served to the browser. This allows a separation
1111
between the asset files stored in the application and the files actually presented
@@ -34,7 +34,7 @@ load them from anywhere) before serving them. This means you can:
3434

3535
* Run image optimizations on your images
3636

37-
.. _cookbook-assetic-assets:
37+
.. _assetic-assets:
3838

3939
Assets
4040
------
@@ -43,12 +43,12 @@ Using Assetic provides many advantages over directly serving the files.
4343
The files do not need to be stored where they are served from and can be
4444
drawn from various sources such as from within a bundle.
4545

46-
You can use Assetic to process :ref:`CSS stylesheets <cookbook-assetic-including-css>`,
47-
:ref:`JavaScript files <cookbook-assetic-including-javascript>` and
48-
:ref:`images <cookbook-assetic-including-image>`. The philosophy
46+
You can use Assetic to process :ref:`CSS stylesheets <assetic-including-css>`,
47+
:ref:`JavaScript files <assetic-including-javascript>` and
48+
:ref:`images <assetic-including-image>`. The philosophy
4949
behind adding either is basically the same, but with a slightly different syntax.
5050

51-
.. _cookbook-assetic-including-javascript:
51+
.. _assetic-including-javascript:
5252

5353
Including JavaScript Files
5454
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -89,7 +89,7 @@ To include JavaScript files, use the ``javascripts`` tag in any template:
8989
9090
.. tip::
9191

92-
You can also include CSS stylesheets: see :ref:`cookbook-assetic-including-css`.
92+
You can also include CSS stylesheets: see :ref:`assetic-including-css`.
9393

9494
In this example, all files in the ``Resources/public/js/`` directory of the
9595
AppBundle will be loaded and served from a different location. The actual
@@ -101,9 +101,9 @@ rendered tag might simply look like:
101101

102102
This is a key point: once you let Assetic handle your assets, the files are
103103
served from a different location. This *will* cause problems with CSS files
104-
that reference images by their relative path. See :ref:`cookbook-assetic-cssrewrite`.
104+
that reference images by their relative path. See :ref:`assetic-cssrewrite`.
105105

106-
.. _cookbook-assetic-including-css:
106+
.. _assetic-including-css:
107107

108108
Including CSS Stylesheets
109109
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -146,7 +146,7 @@ except with the ``stylesheets`` tag:
146146
147147
But because Assetic changes the paths to your assets, this *will* break any
148148
background images (or other paths) that uses relative paths, unless you use
149-
the :ref:`cssrewrite <cookbook-assetic-cssrewrite>` filter.
149+
the :ref:`cssrewrite <assetic-cssrewrite>` filter.
150150

151151
.. note::
152152

@@ -157,7 +157,7 @@ the :ref:`cssrewrite <cookbook-assetic-cssrewrite>` filter.
157157
that there is a known issue that causes the ``cssrewrite`` filter to fail
158158
when using the ``@AppBundle`` syntax for CSS stylesheets.
159159

160-
.. _cookbook-assetic-including-image:
160+
.. _assetic-including-image:
161161

162162
Including Images
163163
~~~~~~~~~~~~~~~~
@@ -189,7 +189,7 @@ You can also use Assetic for image optimization. More information in
189189
`LiipImagineBundle`_ community bundle, which allows to compress and
190190
manipulate images (rotate, resize, watermark, etc.) before serving them.
191191

192-
.. _cookbook-assetic-cssrewrite:
192+
.. _assetic-cssrewrite:
193193

194194
Fixing CSS Paths with the ``cssrewrite`` Filter
195195
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -250,7 +250,7 @@ the JavaScript files.
250250
If you're new to Assetic and try to use your application in the ``prod``
251251
environment (by using the ``app.php`` controller), you'll likely see
252252
that all of your CSS and JS breaks. Don't worry! This is on purpose.
253-
For details on using Assetic in the ``prod`` environment, see :ref:`cookbook-assetic-dumping`.
253+
For details on using Assetic in the ``prod`` environment, see :ref:`assetic-dumping`.
254254

255255
And combining files doesn't only apply to *your* files. You can also use Assetic to
256256
combine third party assets, such as jQuery, with your own into a single file:
@@ -354,7 +354,7 @@ with the ``@named_asset`` notation:
354354
<script src="<?php echo $view->escape($url) ?>"></script>
355355
<?php endforeach ?>
356356
357-
.. _cookbook-assetic-filters:
357+
.. _assetic-filters:
358358

359359
Filters
360360
-------
@@ -474,7 +474,7 @@ done from the template and is relative to the public document root:
474474
via configuration on each deployment. For more information, see the
475475
:ref:`reference-framework-assets-version` configuration option.
476476

477-
.. _cookbook-assetic-dumping:
477+
.. _assetic-dumping:
478478

479479
Dumping Asset Files
480480
-------------------
@@ -508,7 +508,7 @@ by Symfony (as the asset files are in the ``dev`` environment). This is on
508508
purpose - letting Symfony generate these files dynamically in a production
509509
environment is just too slow.
510510

511-
.. _cookbook-assetic-dump-prod:
511+
.. _assetic-dump-prod:
512512

513513
Instead, each time you use your application in the ``prod`` environment (and therefore,
514514
each time you deploy), you should run the following command:

Diff for: assetic/uglifyjs.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ to combine and minify JavaScript assets so that they require less HTTP requests
99
and make your site load faster. `UglifyCSS`_ is a CSS compressor/beautifier
1010
that is very similar to UglifyJS.
1111

12-
In this cookbook, the installation, configuration and usage of UglifyJS is
12+
In this article, the installation, configuration and usage of UglifyJS is
1313
shown in detail. UglifyCSS works pretty much the same way and is only
1414
talked about briefly.
1515

@@ -234,14 +234,14 @@ apply this filter when debug mode is off (e.g. ``app.php``):
234234
<?php endforeach ?>
235235
236236
To try this out, switch to your ``prod`` environment (``app.php``). But before
237-
you do, don't forget to :ref:`clear your cache <book-page-creation-prod-cache-clear>`
238-
and :ref:`dump your assetic assets <cookbook-assetic-dump-prod>`.
237+
you do, don't forget to :ref:`clear your cache <page-creation-prod-cache-clear>`
238+
and :ref:`dump your assetic assets <assetic-dump-prod>`.
239239

240240
.. tip::
241241

242242
Instead of adding the filters to the asset tags, you can also configure which
243243
filters to apply for each file in your application configuration file.
244-
See :ref:`cookbook-assetic-apply-to` for more details.
244+
See :ref:`assetic-apply-to` for more details.
245245

246246
Install, Configure and Use UglifyCSS
247247
------------------------------------

Diff for: assetic/yuicompressor.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ apply this filter when debug mode is off.
171171
example in the ``yui_js`` filter ``apply_to: "\.js$"``. To only have the filter
172172
applied in production, add this to the ``config_prod`` file rather than the
173173
common config file. For details on applying filters by file extension,
174-
see :ref:`cookbook-assetic-apply-to`.
174+
see :ref:`assetic-apply-to`.
175175

176176
.. _`YUI Compressor`: http://yui.github.io/yuicompressor/
177177
.. _`Download the JAR`: https://github.com/yui/yuicompressor/releases

Diff for: best_practices/creating-the-project.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Installer**, which has to be installed before creating your first project.
1212

1313
Use the Symfony Installer to create new Symfony-based projects.
1414

15-
Read the :doc:`installation & setup chapter </setup>` of the Symfony Book to
16-
learn how to install and use the Symfony Installer.
15+
Read the :doc:`/setup` article learn how to install and use the Symfony
16+
Installer.
1717

1818
.. _linux-and-mac-os-x-systems:
1919
.. _windows-systems:

Diff for: best_practices/forms.rst

+3-4
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Registering Forms as Services
7272
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7373

7474
You can also
75-
:ref:`register your form type as a service <form-cookbook-form-field-service>`.
75+
:ref:`register your form type as a service <form-field-service>`.
7676
But this is *not* recommended unless you plan to reuse the new form type in many
7777
places or embed it in other forms directly or via the
7878
:doc:`collection type </reference/forms/types/collection>`.
@@ -171,9 +171,8 @@ all of the fields:
171171

172172
If you need more control over how your fields are rendered, then you should
173173
remove the ``form_widget(form)`` function and render your fields individually.
174-
See the :doc:`/form/form_customization` cookbook article for more information
175-
on this and how you can control *how* the form renders at a global level
176-
using form theming.
174+
See :doc:`/form/form_customization` for more information on this and how you
175+
can control *how* the form renders at a global level using form theming.
177176

178177
Handling Form Submits
179178
---------------------

Diff for: best_practices/security.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Authentication and Firewalls (i.e. Getting the User's Credentials)
66

77
You can configure Symfony to authenticate your users using any method you
88
want and to load user information from any source. This is a complex topic, but
9-
the :doc:`Security Cookbook Section </security>` has a lot of information about
9+
the :doc:`Security guide</security>` has a lot of information about
1010
this.
1111

1212
Regardless of your needs, authentication is configured in ``security.yml``,

Diff for: bundles.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ in your application and to optimize them the way you want.
1616

1717
.. note::
1818

19-
While you'll learn the basics here, an entire cookbook entry is devoted
20-
to the organization and best practices of :doc:`bundles </bundles/best_practices>`.
19+
While you'll learn the basics here, an entire article is devoted to the
20+
organization and best practices of :doc:`bundles </bundles/best_practices>`.
2121

2222
A bundle is simply a structured set of files within a directory that implement
2323
a single feature. You might create a BlogBundle, a ForumBundle or
@@ -167,10 +167,10 @@ of the most common elements of a bundle:
167167
A bundle can be as small or large as the feature it implements. It contains
168168
only the files you need and nothing else.
169169

170-
As you move through the book, you'll learn how to persist objects to a database,
171-
create and validate forms, create translations for your application, write
172-
tests and much more. Each of these has their own place and role within the
173-
bundle.
170+
As you move through the guides, you'll learn how to persist objects to a
171+
database, create and validate forms, create translations for your application,
172+
write tests and much more. Each of these has their own place and role within
173+
the bundle.
174174

175175
Learn more
176176
----------

Diff for: bundles/best_practices.rst

+4-3
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This article is all about how to structure your **reusable bundles** so that
1313
they're easy to configure and extend. Many of these recommendations do not
1414
apply to application bundles because you'll want to keep those as simple
1515
as possible. For application bundles, just follow the practices shown throughout
16-
the book and cookbook.
16+
the guides.
1717

1818
.. seealso::
1919

@@ -463,10 +463,11 @@ API is being used. The following code, would work for *all* users::
463463
}
464464
}
465465

466-
Learn more from the Cookbook
467-
----------------------------
466+
Learn more
467+
----------
468468

469469
* :doc:`/bundles/extension`
470+
* :doc:`/bundles/configuration`
470471

471472
.. _`PSR-0`: http://www.php-fig.org/psr/psr-0/
472473
.. _`PSR-4`: http://www.php-fig.org/psr/psr-4/

Diff for: components/form.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ object to read data off of the correct PHP superglobals (i.e. ``$_POST`` or
8383

8484
If you need more control over exactly when your form is submitted or which
8585
data is passed to it, you can use the :method:`Symfony\\Component\\Form\\FormInterface::submit`
86-
for this. Read more about it :ref:`in the cookbook <cookbook-form-call-submit-directly>`.
86+
for this. Read more about it :ref:`form-call-submit-directly`.
8787

8888
.. sidebar:: Integration with the HttpFoundation Component
8989

@@ -218,7 +218,7 @@ The exact details of your `Twig Configuration`_ will vary, but the goal is
218218
always to add the :class:`Symfony\\Bridge\\Twig\\Extension\\FormExtension`
219219
to Twig, which gives you access to the Twig functions for rendering forms.
220220
To do this, you first need to create a :class:`Symfony\\Bridge\\Twig\\Form\\TwigRendererEngine`,
221-
where you define your :ref:`form themes <cookbook-form-customization-form-themes>`
221+
where you define your :ref:`form themes <form-customization-form-themes>`
222222
(i.e. resources/files that define form HTML markup).
223223

224224
For general details on rendering forms, see :doc:`/form/form_customization`.
@@ -470,8 +470,8 @@ builder:
470470
.. tip::
471471

472472
In this example, the default data is an array. Later, when you use the
473-
:ref:`data_class <book-forms-data-class>` option to bind data directly
474-
to objects, your default data will be an instance of that object.
473+
:ref:`data_class <form-data-class>` option to bind data directly to
474+
objects, your default data will be an instance of that object.
475475

476476
.. _component-form-intro-rendering-form:
477477

Diff for: configuration.rst

+2-3
Original file line numberDiff line numberDiff line change
@@ -124,9 +124,8 @@ dump of all available configuration options by running:
124124
.. index::
125125
single: Environments; Introduction
126126

127-
.. _environments-summary:
128127
.. _page-creation-environments:
129-
.. _book-page-creation-prod-cache-clear:
128+
.. _page-creation-prod-cache-clear:
130129

131130
The imports Key: Loading other Configuration Files
132131
--------------------------------------------------
@@ -261,7 +260,7 @@ signs - e.g. ``%locale%``.
261260
See :doc:`/configuration/external_parameters`.
262261

263262
For more information about parameters - including how to reference them from inside
264-
a controller - see :ref:`book-service-container-parameters`.
263+
a controller - see :ref:`service-container-parameters`.
265264

266265
.. _config-parameters-yml:
267266

Diff for: configuration/using_parameters_in_dic.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Using Parameters within a Dependency Injection Class
55
----------------------------------------------------
66

77
You have seen how to use configuration parameters within
8-
:ref:`Symfony service containers <book-service-container-parameters>`.
8+
:ref:`Symfony service containers <service-container-parameters>`.
99
There are special cases such as when you want, for instance, to use the
1010
``%kernel.debug%`` parameter to make the services in your bundle enter
1111
debug mode. For this case there is more work to do in order

Diff for: console/command_in_controller.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
How to Call a Command from a Controller
55
=======================================
66

7-
The :doc:`Console component documentation </components/console>`
8-
covers how to create a console command. This cookbook article covers how
9-
to use a console command directly from your controller.
7+
The :doc:`Console component documentation </components/console>` covers how to
8+
create a console command. This article covers how to use a console command
9+
directly from your controller.
1010

1111
You may have the need to execute some function that is only available in a
1212
console command. Usually, you should refactor the command and move some logic

Diff for: contributing/documentation/overview.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ In this section, you'll learn how to contribute to the Symfony documentation for
7171
the first time. The next section will explain the shorter process you'll follow
7272
in the future for every contribution after your first one.
7373

74-
Let's imagine that you want to improve the installation chapter of the Symfony
75-
book. In order to make your changes, follow these steps:
74+
Let's imagine that you want to improve the Setup guide. In order to make your
75+
changes, follow these steps:
7676

7777
**Step 1.** Go to the official Symfony documentation repository located at
7878
`github.com/symfony/symfony-docs`_ and click on the **Fork** button to `fork the

Diff for: controller.rst

+3-5
Original file line numberDiff line numberDiff line change
@@ -159,8 +159,6 @@ method is just a helper method that generates the URL for a given route::
159159

160160
$url = $this->generateUrl('blog_show', array('slug' => 'slug-value'));
161161

162-
.. _book-redirecting-users-browser:
163-
164162
Redirecting
165163
~~~~~~~~~~~
166164

@@ -315,13 +313,13 @@ error page is shown to the developer (i.e. when you're using the ``app_dev.php``
315313
front controller - see :ref:`page-creation-environments`).
316314

317315
You'll want to customize the error page your user sees. To do that, see
318-
the ":doc:`/controller/error_pages`" cookbook recipe.
316+
the :doc:`/controller/error_pages` article.
319317

320318
.. index::
321319
single: Controller; The session
322320
single: Session
323321

324-
.. _book-controller-request-argument:
322+
.. _controller-request-argument:
325323

326324
The Request object as a Controller Argument
327325
-------------------------------------------
@@ -455,7 +453,7 @@ read any flash messages from the session:
455453
The Request and Response Object
456454
-------------------------------
457455

458-
As mentioned :ref:`earlier <book-controller-request-argument>`, the framework will
456+
As mentioned :ref:`earlier <controller-request-argument>`, the framework will
459457
pass the ``Request`` object to any controller argument that is type-hinted with
460458
the ``Request`` class::
461459

Diff for: controller/error_pages.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Overriding the Default Error Templates
4444
When the error page loads, an internal :class:`Symfony\\Bundle\\TwigBundle\\Controller\\ExceptionController`
4545
is used to render a Twig template to show the user.
4646

47-
.. _cookbook-error-pages-by-status-code:
47+
.. _controller-error-pages-by-status-code:
4848

4949
This controller uses the HTTP status code, the request format and the following
5050
logic to determine the template filename:

Diff for: controller/service.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ How to Define Controllers as Services
1010
They are used by some developers for very specific use cases, such as
1111
DDD (*domain-driven design*) and Hexagonal Architecture applications.
1212

13-
In the book, you've learned how easily a controller can be used when it
14-
extends the base
13+
In the :doc:`/controller` guide, you've learned how easily a controller can be
14+
used when it extends the base
1515
:class:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller` class. While
1616
this works fine, controllers can also be specified as services. Even if you don't
1717
specify your controllers as services, you might see them being used in some

0 commit comments

Comments
 (0)