Permalink
Browse files

minor #4042 [Cookbook] apply headline guidelines to the cookbook arti…

…cles (xabbuh)

This PR was merged into the 2.3 branch.

Discussion
----------

[Cookbook] apply headline guidelines to the cookbook articles

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | all
| Fixed tickets |

This completes the work started in #3765, #3828 and #3829.

Commits
-------

1fa40f3 apply headline guidelines to the cookbook articles
  • Loading branch information...
weaverryan committed Jul 29, 2014
2 parents f25faf3 + 1fa40f3 commit a834a7e883e78005ed41a6cea0dcee058ed85b1f
Showing with 210 additions and 210 deletions.
  1. +5 −5 cookbook/assetic/apply_to_option.rst
  2. +4 −4 cookbook/assetic/asset_management.rst
  3. +3 −3 cookbook/assetic/jpeg_optimize.rst
  4. +2 −2 cookbook/assetic/uglifyjs.rst
  5. +1 −1 cookbook/bundles/best_practices.rst
  6. +3 −3 cookbook/bundles/extension.rst
  7. +1 −1 cookbook/bundles/inheritance.rst
  8. +1 −1 cookbook/bundles/installation.rst
  9. +2 −2 cookbook/bundles/override.rst
  10. +1 −1 cookbook/bundles/prepend_extension.rst
  11. +7 −7 cookbook/bundles/remove.rst
  12. +2 −2 cookbook/cache/varnish.rst
  13. +3 −3 cookbook/configuration/apache_router.rst
  14. +5 −5 cookbook/configuration/environments.rst
  15. +1 −1 cookbook/configuration/external_parameters.rst
  16. +1 −1 cookbook/configuration/front_controllers_and_kernel.rst
  17. +4 −4 cookbook/configuration/override_dir_structure.rst
  18. +1 −1 cookbook/configuration/pdo_session_storage.rst
  19. +1 −1 cookbook/configuration/web_server_configuration.rst
  20. +1 −1 cookbook/console/console_command.rst
  21. +4 −4 cookbook/console/logging.rst
  22. +1 −1 cookbook/console/sending_emails.rst
  23. +2 −2 cookbook/console/usage.rst
  24. +1 −1 cookbook/controller/error_pages.rst
  25. +3 −3 cookbook/controller/service.rst
  26. +1 −1 cookbook/debugging.rst
  27. +2 −2 cookbook/deployment/azure-website.rst
  28. +7 −7 cookbook/deployment/tools.rst
  29. +1 −1 cookbook/doctrine/custom_dql_functions.rst
  30. +3 −3 cookbook/doctrine/dbal.rst
  31. +5 −5 cookbook/doctrine/file_uploads.rst
  32. +1 −1 cookbook/doctrine/mapping_model_classes.rst
  33. +1 −1 cookbook/doctrine/multiple_entity_managers.rst
  34. +5 −5 cookbook/doctrine/registration_form.rst
  35. +1 −1 cookbook/doctrine/reverse_engineering.rst
  36. +1 −1 cookbook/email/cloud.rst
  37. +1 −1 cookbook/email/dev_environment.rst
  38. +1 −1 cookbook/email/email.rst
  39. +1 −1 cookbook/email/gmail.rst
  40. +2 −2 cookbook/email/spool.rst
  41. +1 −1 cookbook/email/testing.rst
  42. +5 −5 cookbook/event_dispatcher/before_after_filters.rst
  43. +1 −1 cookbook/event_dispatcher/class_extension.rst
  44. +1 −1 cookbook/event_dispatcher/method_behavior.rst
  45. +3 −3 cookbook/form/data_transformers.rst
  46. +2 −2 cookbook/form/direct_submit.rst
  47. +3 −3 cookbook/form/dynamic_form_modification.rst
  48. +4 −4 cookbook/form/form_collections.rst
  49. +11 −11 cookbook/form/form_customization.rst
  50. +1 −1 cookbook/form/unit_testing.rst
  51. +1 −1 cookbook/form/use_empty_data.rst
  52. +1 −1 cookbook/form/use_virtuals_forms.rst
  53. +2 −2 cookbook/logging/channels_handlers.rst
  54. +5 −5 cookbook/logging/monolog.rst
  55. +3 −3 cookbook/profiler/data_collector.rst
  56. +2 −2 cookbook/profiler/matchers.rst
  57. +1 −1 cookbook/request/mime_type.rst
  58. +5 −5 cookbook/routing/custom_route_loader.rst
  59. +4 −4 cookbook/routing/method_parameters.rst
  60. +1 −1 cookbook/routing/redirect_in_config.rst
  61. +1 −1 cookbook/routing/scheme.rst
  62. +1 −1 cookbook/routing/service_container_parameters.rst
  63. +1 −1 cookbook/routing/slash_in_parameter.rst
  64. +3 −3 cookbook/security/acl.rst
  65. +1 −1 cookbook/security/acl_advanced.rst
  66. +2 −2 cookbook/security/custom_authentication_provider.rst
  67. +2 −2 cookbook/security/custom_provider.rst
  68. +2 −2 cookbook/security/entity_provider.rst
  69. +1 −1 cookbook/security/force_https.rst
  70. +3 −3 cookbook/security/form_login.rst
  71. +2 −2 cookbook/security/remember_me.rst
  72. +1 −1 cookbook/security/securing_services.rst
  73. +1 −1 cookbook/security/target_path.rst
  74. +3 −3 cookbook/security/voters.rst
  75. +2 −2 cookbook/security/voters_data_permission.rst
  76. +3 −3 cookbook/serializer.rst
  77. +1 −1 cookbook/service_container/compiler_passes.rst
  78. +2 −2 cookbook/service_container/event_listener.rst
  79. +1 −1 cookbook/service_container/scopes.rst
  80. +1 −1 cookbook/session/php_bridge.rst
  81. +3 −3 cookbook/session/sessions_directory.rst
  82. +1 −1 cookbook/symfony1.rst
  83. +3 −3 cookbook/templating/PHP.rst
  84. +1 −1 cookbook/templating/global_variables.rst
  85. +1 −1 cookbook/templating/render_without_controller.rst
  86. +1 −1 cookbook/templating/twig_extension.rst
  87. +1 −1 cookbook/testing/bootstrap.rst
  88. +2 −2 cookbook/testing/database.rst
  89. +1 −1 cookbook/testing/doctrine.rst
  90. +1 −1 cookbook/testing/http_authentication.rst
  91. +1 −1 cookbook/testing/insulating_clients.rst
  92. +1 −1 cookbook/testing/profiling.rst
  93. +1 −1 cookbook/testing/simulating_authentication.rst
  94. +3 −3 cookbook/validation/custom_constraint.rst
  95. +1 −1 cookbook/workflow/_vendor_deps.rst.inc
  96. +2 −2 cookbook/workflow/new_project_git.rst
  97. +2 −2 cookbook/workflow/new_project_svn.rst
@@ -1,7 +1,7 @@
.. index::
single: Assetic; Apply filters
How to Apply an Assetic Filter to a Specific File Extension
How to Apply an Assetic Filter to a specific File Extension
===========================================================
Assetic filters can be applied to individual files, groups of files or even,
@@ -49,7 +49,7 @@ An example configuration might look like this:
),
));
Filter a Single File
Filter a single File
--------------------
You can now serve up a single CoffeeScript file as JavaScript from within your
@@ -75,7 +75,7 @@ templates:
This is all that's needed to compile this CoffeeScript file and serve it
as the compiled JavaScript.
Filter Multiple Files
Filter multiple Files
---------------------
You can also combine multiple CoffeeScript files into a single output file:
@@ -107,7 +107,7 @@ JavaScript.
.. _cookbook-assetic-apply-to:
Filtering based on a File Extension
Filtering Based on a File Extension
-----------------------------------
One of the great advantages of using Assetic is reducing the number of asset
@@ -146,7 +146,7 @@ applied to all ``.coffee`` files:
apply_to="\.coffee$" />
<assetic:node-paths>/usr/lib/node_modules/</assetic:node-path>
</assetic:config>
.. code-block:: php
// app/config/config.php
@@ -159,7 +159,7 @@ the :ref:`cssrewrite <cookbook-assetic-cssrewrite>` filter.
.. _cookbook-assetic-including-image:
Including images
Including Images
~~~~~~~~~~~~~~~~
To include an image you can use the ``image`` tag.
@@ -422,7 +422,7 @@ into your template:
A more detailed guide about configuring and using Assetic filters as well as
details of Assetic's debug mode can be found in :doc:`/cookbook/assetic/uglifyjs`.
Controlling the URL used
Controlling the URL Used
------------------------
If you wish to, you can control the URLs that Assetic produces. This is
@@ -471,7 +471,7 @@ it might be downright frustrating.
Fortunately, Assetic provides a way to dump your assets to real files, instead
of being generated dynamically.
Dumping Asset Files in the ``prod`` environment
Dumping Asset Files in the ``prod`` Environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In the ``prod`` environment, your JS and CSS files are represented by a single
@@ -500,7 +500,7 @@ This will physically generate and write each file that you need (e.g. ``/js/abcd
If you update any of your assets, you'll need to run this again to regenerate
the file.
Dumping Asset Files in the ``dev`` environment
Dumping Asset Files in the ``dev`` Environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
By default, each asset path generated in the ``dev`` environment is handled
@@ -1,7 +1,7 @@
.. index::
single: Assetic; Image optimization
How to Use Assetic For Image Optimization with Twig Functions
How to Use Assetic for Image Optimization with Twig Functions
=============================================================
Amongst its many filters, Assetic has four filters which can be used for on-the-fly
@@ -111,7 +111,7 @@ remove these by using the ``strip_all`` option:
),
));
Lowering Maximum Quality
Lowering maximum Quality
~~~~~~~~~~~~~~~~~~~~~~~~
The quality level of the JPEG is not affected by default. You can gain
@@ -152,7 +152,7 @@ image quality:
),
));
Shorter syntax: Twig Function
Shorter Syntax: Twig Function
-----------------------------
If you're using Twig, it's possible to achieve all of this with a shorter
@@ -1,7 +1,7 @@
.. index::
single: Assetic; UglifyJS
How to Minify CSS/JS Files (using UglifyJS and UglifyCSS)
How to Minify CSS/JS Files (Using UglifyJS and UglifyCSS)
=========================================================
`UglifyJS`_ is a JavaScript parser/compressor/beautifier toolkit. It can be used
@@ -183,7 +183,7 @@ and :ref:`dump your assetic assets <cookbook-asetic-dump-prod>`.
rather than the common config file. For details on applying filters by
file extension, see :ref:`cookbook-assetic-apply-to`.
Install, configure and use UglifyCSS
Install, Configure and Use UglifyCSS
------------------------------------
The usage of UglifyCSS works the same way as UglifyJS. First, make sure
@@ -1,7 +1,7 @@
.. index::
single: Bundle; Best practices
How to use Best Practices for Structuring Bundles
How to Use best Practices for Structuring Bundles
=================================================
A bundle is a directory that has a well-defined structure and can host anything
@@ -2,7 +2,7 @@
single: Configuration; Semantic
single: Bundle; Extension configuration
How to expose a Semantic Configuration for a Bundle
How to Expose a semantic Configuration for a Bundle
===================================================
If you open your application configuration file (usually ``app/config/config.yml``),
@@ -330,7 +330,7 @@ information loaded from other bundles). The goal of the ``load()`` method
is to manipulate the container, adding and configuring any methods or services
needed by your bundle.
Loading External Configuration Resources
Loading external Configuration Resources
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
One common thing to do is to load an external configuration file that may
@@ -549,7 +549,7 @@ normalization and advanced merging. You can read more about this in
You can also see it in action by checking out some of the core Configuration classes,
such as the one from the `FrameworkBundle Configuration`_ or the `TwigBundle Configuration`_.
Modifying the configuration of another Bundle
Modifying the Configuration of another Bundle
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you have multiple bundles that depend on each other, it may be useful
@@ -1,7 +1,7 @@
.. index::
single: Bundle; Inheritance
How to use Bundle Inheritance to Override parts of a Bundle
How to Use Bundle Inheritance to Override Parts of a Bundle
===========================================================
When working with third-party bundles, you'll probably come across a situation
@@ -1,7 +1,7 @@
.. index::
single: Bundle; Installation
How to install 3rd party Bundles
How to Install 3rd Party Bundles
================================
Most bundles provide their own installation instructions. However, the
@@ -93,7 +93,7 @@ See :doc:`/cookbook/service_container/compiler_passes` for information on how to
compiler passes. If you want to do something beyond just overriding the class -
like adding a method call - you can only use the compiler pass method.
Entities & Entity mapping
Entities & Entity Mapping
-------------------------
Due to the way Doctrine works, it is not possible to override entity mapping
@@ -119,7 +119,7 @@ rather than::
.. _override-validation:
Validation metadata
Validation Metadata
-------------------
Symfony loads all validation configuration files from every bundle and
@@ -2,7 +2,7 @@
single: Configuration; Semantic
single: Bundle; Extension configuration
How to simplify configuration of multiple Bundles
How to Simplify Configuration of multiple Bundles
=================================================
When building reusable and extensible applications, developers are often
@@ -1,7 +1,7 @@
.. index::
single: Bundle; Removing AcmeDemoBundle
How to remove the AcmeDemoBundle
How to Remove the AcmeDemoBundle
================================
The Symfony2 Standard Edition comes with a complete demo that lives inside a
@@ -13,7 +13,7 @@ starting a project, but you'll probably want to eventually remove it.
This article uses the AcmeDemoBundle as an example, but you can use
these steps to remove any bundle.
1. Unregister the bundle in the ``AppKernel``
1. Unregister the Bundle in the ``AppKernel``
---------------------------------------------
To disconnect the bundle from the framework, you should remove the bundle from
@@ -38,20 +38,20 @@ development environment and you can find it inside the if statement below::
}
}
2. Remove bundle configuration
2. Remove Bundle Configuration
------------------------------
Now that Symfony doesn't know about the bundle, you need to remove any
configuration and routing configuration inside the ``app/config`` directory
that refers to the bundle.
2.1 Remove bundle routing
2.1 Remove Bundle Routing
~~~~~~~~~~~~~~~~~~~~~~~~~
The routing for the AcmeDemoBundle can be found in ``app/config/routing_dev.yml``.
Remove the ``_acme_demo`` entry at the bottom of this file.
2.2 Remove bundle configuration
2.2 Remove Bundle Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Some bundles contain configuration in one of the ``app/config/config*.yml``
@@ -65,7 +65,7 @@ used in the configuration for the ``app/config/security.yml`` file. You can
use it as a boilerplate for your own security, but you **can** also remove
everything: it doesn't matter to Symfony if you remove it or not.
3. Remove the bundle from the Filesystem
3. Remove the Bundle from the Filesystem
----------------------------------------
Now you have removed every reference to the bundle in your application, you
@@ -81,7 +81,7 @@ can remove the ``Acme`` directory as well.
echo $this->container->get('kernel')->getBundle('AcmeDemoBundle')->getPath();
4. Remove integration in other bundles
4. Remove Integration in other Bundles
--------------------------------------
.. note::
@@ -1,7 +1,7 @@
.. index::
single: Cache; Varnish
How to use Varnish to speed up my Website
How to Use Varnish to Speed up my Website
=========================================
Because Symfony2's cache uses the standard HTTP cache headers, the
@@ -62,7 +62,7 @@ Symfony2 adds automatically:
// For Varnish < 3.0
// esi;
}
/* By default Varnish ignores Cache-Control: nocache
/* By default Varnish ignores Cache-Control: nocache
(https://www.varnish-cache.org/docs/3.0/tutorial/increasing_your_hitrate.html#cache-control),
so in order avoid caching it has to be done explicitly */
if (beresp.http.Pragma ~ "no-cache" ||
@@ -1,7 +1,7 @@
.. index::
single: Apache Router
How to use the Apache Router
How to Use the Apache Router
============================
Symfony2, while fast out of the box, also provides various ways to increase that speed with a little bit of tweaking.
@@ -49,7 +49,7 @@ Symfony2 to use the ``ApacheUrlMatcher`` instead of the default one:
at the end of ``ApacheUrlMatcher::match()`` a call to ``parent::match()``
is done).
Generating mod_rewrite rules
Generating mod_rewrite Rules
----------------------------
To test that it's working, create a very basic route for the AcmeDemoBundle:
@@ -119,7 +119,7 @@ it should look like this:
That's it!
You're now all set to use Apache routes.
Additional tweaks
Additional Tweaks
-----------------
To save a little bit of processing time, change occurrences of ``Request``
@@ -16,7 +16,7 @@ optimized for speed.
.. index::
single: Environments; Configuration files
Different Environments, Different Configuration Files
Different Environments, different Configuration Files
-----------------------------------------------------
A typical Symfony2 application begins with three environments: ``dev``,
@@ -125,7 +125,7 @@ activated by modifying the default value in the ``dev`` configuration file:
.. index::
single: Environments; Executing different environments
Executing an Application in Different Environments
Executing an Application in different Environments
--------------------------------------------------
To execute the application in each environment, load up the application using
@@ -147,7 +147,7 @@ If you open up one of these files, you'll quickly see that the environment
used by each is explicitly set::
// web/app.php
// ...
// ...
$kernel = new AppKernel('prod', false);
@@ -215,7 +215,7 @@ environment by using this code and changing the environment string.
.. index::
single: Environments; Creating a new environment
Creating a New Environment
Creating a new Environment
--------------------------
By default, a Symfony2 application has three environments that handle most
@@ -345,7 +345,7 @@ includes the following:
You can easily change the directory location and name. For more information
read the article :doc:`/cookbook/configuration/override_dir_structure`.
Going Further
Going further
-------------
Read the article on :doc:`/cookbook/configuration/external_parameters`.
@@ -1,7 +1,7 @@
.. index::
single: Environments; External parameters
How to Set External Parameters in the Service Container
How to Set external Parameters in the Service Container
=======================================================
In the chapter :doc:`/cookbook/configuration/environments`, you learned how
@@ -2,7 +2,7 @@
single: How the front controller, ``AppKernel`` and environments
work together
Understanding how the Front Controller, Kernel and Environments work together
Understanding how the Front Controller, Kernel and Environments Work together
=============================================================================
The section :doc:`/cookbook/configuration/environments` explained the basics
Oops, something went wrong.

0 comments on commit a834a7e

Please sign in to comment.