Skip to content

Commit

Permalink
Remove mentions of cookbook/book
Browse files Browse the repository at this point in the history
  • Loading branch information
wouterj authored and javiereguiluz committed Jul 15, 2016
1 parent 473b446 commit ca035f0
Showing 95 changed files with 312 additions and 367 deletions.
2 changes: 1 addition & 1 deletion assetic/apply_to_option.rst
Original file line number Diff line number Diff line change
@@ -114,7 +114,7 @@ You can also combine multiple CoffeeScript files into a single output file:

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

.. _cookbook-assetic-apply-to:
.. _assetic-apply-to:

Filtering Based on a File Extension
-----------------------------------
34 changes: 17 additions & 17 deletions assetic/asset_management.rst
Original file line number Diff line number Diff line change
@@ -4,8 +4,8 @@
How to Use Assetic for Asset Management
=======================================

Assetic combines two major ideas: :ref:`assets <cookbook-assetic-assets>` and
:ref:`filters <cookbook-assetic-filters>`. The assets are files such as CSS,
Assetic combines two major ideas: :ref:`assets <assetic-assets>` and
:ref:`filters <assetic-filters>`. The assets are files such as CSS,
JavaScript and image files. The filters are things that can be applied to
these files before they are served to the browser. This allows a separation
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:

* Run image optimizations on your images

.. _cookbook-assetic-assets:
.. _assetic-assets:

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

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

.. _cookbook-assetic-including-javascript:
.. _assetic-including-javascript:

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

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

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

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

.. _cookbook-assetic-including-css:
.. _assetic-including-css:

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

.. note::

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

.. _cookbook-assetic-including-image:
.. _assetic-including-image:

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

.. _cookbook-assetic-cssrewrite:
.. _assetic-cssrewrite:

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

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

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

.. _cookbook-assetic-dumping:
.. _assetic-dumping:

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

.. _cookbook-assetic-dump-prod:
.. _assetic-dump-prod:

Instead, each time you use your application in the ``prod`` environment (and therefore,
each time you deploy), you should run the following command:
8 changes: 4 additions & 4 deletions assetic/uglifyjs.rst
Original file line number Diff line number Diff line change
@@ -9,7 +9,7 @@ to combine and minify JavaScript assets so that they require less HTTP requests
and make your site load faster. `UglifyCSS`_ is a CSS compressor/beautifier
that is very similar to UglifyJS.

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

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

.. tip::

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

Install, Configure and Use UglifyCSS
------------------------------------
2 changes: 1 addition & 1 deletion assetic/yuicompressor.rst
Original file line number Diff line number Diff line change
@@ -171,7 +171,7 @@ apply this filter when debug mode is off.
example in the ``yui_js`` filter ``apply_to: "\.js$"``. To only have the filter
applied in production, add this to the ``config_prod`` file rather than the
common config file. For details on applying filters by file extension,
see :ref:`cookbook-assetic-apply-to`.
see :ref:`assetic-apply-to`.

.. _`YUI Compressor`: http://yui.github.io/yuicompressor/
.. _`Download the JAR`: https://github.com/yui/yuicompressor/releases
4 changes: 2 additions & 2 deletions best_practices/creating-the-project.rst
Original file line number Diff line number Diff line change
@@ -12,8 +12,8 @@ Installer**, which has to be installed before creating your first project.

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

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

.. _linux-and-mac-os-x-systems:
.. _windows-systems:
7 changes: 3 additions & 4 deletions best_practices/forms.rst
Original file line number Diff line number Diff line change
@@ -72,7 +72,7 @@ Registering Forms as Services
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

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

Handling Form Submits
---------------------
2 changes: 1 addition & 1 deletion best_practices/security.rst
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ Authentication and Firewalls (i.e. Getting the User's Credentials)

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

Regardless of your needs, authentication is configured in ``security.yml``,
12 changes: 6 additions & 6 deletions bundles.rst
Original file line number Diff line number Diff line change
@@ -16,8 +16,8 @@ in your application and to optimize them the way you want.

.. note::

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

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

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

Learn more
----------
7 changes: 4 additions & 3 deletions bundles/best_practices.rst
Original file line number Diff line number Diff line change
@@ -13,7 +13,7 @@ This article is all about how to structure your **reusable bundles** so that
they're easy to configure and extend. Many of these recommendations do not
apply to application bundles because you'll want to keep those as simple
as possible. For application bundles, just follow the practices shown throughout
the book and cookbook.
the guides.

.. seealso::

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

Learn more from the Cookbook
----------------------------
Learn more
----------

* :doc:`/bundles/extension`
* :doc:`/bundles/configuration`

.. _`PSR-0`: http://www.php-fig.org/psr/psr-0/
.. _`PSR-4`: http://www.php-fig.org/psr/psr-4/
2 changes: 1 addition & 1 deletion cache/esi.rst
Original file line number Diff line number Diff line change
@@ -210,7 +210,7 @@ of the master page.
With ESI, the full page cache will be valid for 600 seconds, but the news
component cache will only last for 60 seconds.

.. _book-http_cache-fragments:
.. _http_cache-fragments:

When using a controller reference, the ESI tag should reference the embedded
action as an accessible URL so the gateway cache can fetch it independently of
2 changes: 1 addition & 1 deletion cache/varnish.rst
Original file line number Diff line number Diff line change
@@ -37,7 +37,7 @@ header:
If you do not have access to your Varnish configuration, you can instead
configure Symfony to distrust the ``Forwarded`` header as detailed in
:ref:`the cookbook <cookbook-request-untrust-header>`.
:ref:`How to Configure Symfony to Work behind a Load Balancer or a Reverse Proxy <request-untrust-header>`.

.. _varnish-x-forwarded-headers:

8 changes: 4 additions & 4 deletions components/form.rst
Original file line number Diff line number Diff line change
@@ -83,7 +83,7 @@ object to read data off of the correct PHP superglobals (i.e. ``$_POST`` or

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

.. sidebar:: Integration with the HttpFoundation Component

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

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

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

.. _component-form-intro-rendering-form:

5 changes: 2 additions & 3 deletions configuration.rst
Original file line number Diff line number Diff line change
@@ -124,9 +124,8 @@ dump of all available configuration options by running:
.. index::
single: Environments; Introduction

.. _environments-summary:
.. _page-creation-environments:
.. _book-page-creation-prod-cache-clear:
.. _page-creation-prod-cache-clear:

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

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

.. _config-parameters-yml:

2 changes: 1 addition & 1 deletion configuration/using_parameters_in_dic.rst
Original file line number Diff line number Diff line change
@@ -5,7 +5,7 @@ Using Parameters within a Dependency Injection Class
----------------------------------------------------

You have seen how to use configuration parameters within
:ref:`Symfony service containers <book-service-container-parameters>`.
:ref:`Symfony service containers <service-container-parameters>`.
There are special cases such as when you want, for instance, to use the
``%kernel.debug%`` parameter to make the services in your bundle enter
debug mode. For this case there is more work to do in order
6 changes: 3 additions & 3 deletions console/command_in_controller.rst
Original file line number Diff line number Diff line change
@@ -4,9 +4,9 @@
How to Call a Command from a Controller
=======================================

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

You may have the need to execute some function that is only available in a
console command. Usually, you should refactor the command and move some logic
4 changes: 2 additions & 2 deletions contributing/documentation/overview.rst
Original file line number Diff line number Diff line change
@@ -71,8 +71,8 @@ In this section, you'll learn how to contribute to the Symfony documentation for
the first time. The next section will explain the shorter process you'll follow
in the future for every contribution after your first one.

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

**Step 1.** Go to the official Symfony documentation repository located at
`github.com/symfony/symfony-docs`_ and click on the **Fork** button to `fork the
8 changes: 3 additions & 5 deletions controller.rst
Original file line number Diff line number Diff line change
@@ -159,8 +159,6 @@ method is just a helper method that generates the URL for a given route::

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

.. _book-redirecting-users-browser:

Redirecting
~~~~~~~~~~~

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

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

.. index::
single: Controller; The session
single: Session

.. _book-controller-request-argument:
.. _controller-request-argument:

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

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

2 changes: 1 addition & 1 deletion controller/error_pages.rst
Original file line number Diff line number Diff line change
@@ -44,7 +44,7 @@ Overriding the Default Error Templates
When the error page loads, an internal :class:`Symfony\\Bundle\\TwigBundle\\Controller\\ExceptionController`
is used to render a Twig template to show the user.

.. _cookbook-error-pages-by-status-code:
.. _controller-error-pages-by-status-code:

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

0 comments on commit ca035f0

Please sign in to comment.