minor #3765 [WIP] make headlines consistent with our standards (xabbuh)

This PR was merged into the 2.3 branch. Discussion ---------- [WIP] make headlines consistent with our standards | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | all | Fixed tickets | - [x] Book - [ ] Components - [ ] Contributing - [ ] Cookbook - [x] Quick Tour - [x] Reference Commits ------- 1d2a620 [QuickTour] consistent headlines d49d12e [Reference] consistent headlines 0702d1f [Book] make headlines consistent with our standards
symfony · Apr 12, 2014 · d36bbd9 · d36bbd9
2 parents daa81a0 + 1d2a620
commit d36bbd9
Show file tree

Hide file tree

Showing 48 changed files with 107 additions and 101 deletions.
diff --git a/book/doctrine.rst b/book/doctrine.rst
@@ -30,7 +30,7 @@ The easiest way to understand how Doctrine works is to see it in action.
 In this section, you'll configure your database, create a ``Product`` object,
 persist it to the database and fetch it back out.
 
-.. sidebar:: Code along with the example
+.. sidebar:: Code along with the Example
 
     If you want to follow along with the example in this chapter, create
     an ``AcmeStoreBundle`` via:
@@ -125,7 +125,7 @@ for you:
 
     $ php app/console doctrine:database:create
 
-.. sidebar:: Setting Up The Database to be UTF8
+.. sidebar:: Setting up the Database to be UTF8
 
     One mistake even seasoned developers make when starting a Symfony2 project
     is forgetting to setup default charset and collation on their database,
@@ -1392,7 +1392,7 @@ powerful, allowing you to create complex queries and subscribe to events
 that allow you to take different actions as objects go through their persistence
 lifecycle.
 
-Learn More
+Learn more
 ~~~~~~~~~~
 
 For more information about Doctrine, see the *Doctrine* section of the

diff --git a/book/forms.rst b/book/forms.rst
@@ -618,7 +618,7 @@ Each field type has a number of different options that can be passed to it.
 Many of these are specific to the field type and details can be found in
 the documentation for each type.
 
-.. sidebar:: The ``required`` option
+.. sidebar:: The ``required`` Option
 
     The most common option is the ``required`` option, which can be applied to
     any field. By default, the ``required`` option is set to ``true``, meaning
@@ -636,7 +636,7 @@ the documentation for each type.
     In other words, the ``required`` option is "nice", but true server-side
     validation should *always* be used.
 
-.. sidebar:: The ``label`` option
+.. sidebar:: The ``label`` Option
 
     The label for the form field can be set using the ``label`` option,
     which can be applied to any field::

diff --git a/book/from_flat_php_to_symfony2.rst b/book/from_flat_php_to_symfony2.rst
@@ -16,7 +16,7 @@ to where it is now.
 By the end, you'll see how Symfony2 can rescue you from mundane tasks and
 let you take back control of your code.
 
-A simple Blog in flat PHP
+A Simple Blog in Flat PHP
 -------------------------
 
 In this chapter, you'll build the token blog application using only flat PHP.
@@ -698,7 +698,7 @@ And perhaps best of all, by using Symfony2, you now have access to a whole
 set of **high-quality open source tools developed by the Symfony2 community**!
 A good selection of Symfony2 community tools can be found on `KnpBundles.com`_.
 
-Better templates
+Better Templates
 ----------------
 
 If you choose to use it, Symfony2 comes standard with a templating engine

diff --git a/book/http_cache.rst b/book/http_cache.rst
@@ -234,7 +234,7 @@ If ``debug`` is ``true``, Symfony2 automatically adds a ``X-Symfony-Cache``
 header to the response containing useful information about cache hits and
 misses.
 
-.. sidebar:: Changing from one Reverse Proxy to Another
+.. sidebar:: Changing from one Reverse Proxy to another
 
     The Symfony2 reverse proxy is a great tool to use when developing your
     website or when you deploy your website to a shared host where you cannot
@@ -327,7 +327,7 @@ its creation more manageable::
     // set a custom Cache-Control directive
     $response->headers->addCacheControlDirective('must-revalidate', true);
 
-Public vs Private Responses
+Public vs private Responses
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Both gateway and proxy caches are considered "shared" caches as the cached

diff --git a/book/http_fundamentals.rst b/book/http_fundamentals.rst
@@ -42,7 +42,7 @@ how to master it.
 .. index::
    single: HTTP; Request-response paradigm
 
-Step1: The Client sends a Request
+Step1: The Client Sends a Request
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Every conversation on the web starts with a *request*. The request is a text
@@ -105,7 +105,7 @@ the client accepts (``Accept``) and the application the client is using to
 make the request (``User-Agent``). Many other headers exist and can be found
 on Wikipedia's `List of HTTP header fields`_ article.
 
-Step 2: The Server returns a Response
+Step 2: The Server Returns a Response
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Once a server has received the request, it knows exactly which resource the
@@ -248,7 +248,7 @@ you'll never need to worry about. For example, the ``isSecure()`` method
 checks the *three* different values in PHP that can indicate whether or not
 the user is connecting via a secured connection (i.e. HTTPS).
 
-.. sidebar:: ParameterBags and Request attributes
+.. sidebar:: ParameterBags and Request Attributes
 
     As seen above, the ``$_GET`` and ``$_POST`` variables are accessible via
     the public ``query`` and ``request`` properties respectively. Each of

diff --git a/book/internals.rst b/book/internals.rst
@@ -127,7 +127,7 @@ method returns an array of arguments to pass to the Controller callable. The
 default implementation automatically resolves the method arguments, based on
 the Request attributes.
 
-.. sidebar:: Matching Controller method arguments from Request attributes
+.. sidebar:: Matching Controller Method Arguments from Request Attributes
 
     For each method argument, Symfony2 tries to get the value of a Request
     attribute with the same name. If it is not defined, the argument default
@@ -489,7 +489,7 @@ token link (a string made of 13 random characters) to access the Web Profiler.
     If the token is not clickable, it means that the profiler routes are not
     registered (see below for configuration information).
 
-Analyzing Profiling data with the Web Profiler
+Analyzing Profiling Data with the Web Profiler
 ..............................................
 
 The Web Profiler is a visualization tool for profiling data that you can use

diff --git a/book/propel.rst b/book/propel.rst
@@ -15,7 +15,7 @@ A Simple Example: A Product
 In this section, you'll configure your database, create a ``Product`` object,
 persist it to the database and fetch it back out.
 
-.. sidebar:: Code along with the example
+.. sidebar:: Code along with the Example
 
     If you want to follow along with the example in this chapter, create an
     ``AcmeStoreBundle`` via:
@@ -425,7 +425,7 @@ before. First, fetch a ``$product`` object and then access its related
 
 Note, in the above example, only one query was made.
 
-More information on Associations
+More Information on Associations
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 You will find more information on relations by reading the dedicated chapter on

diff --git a/book/routing.rst b/book/routing.rst
@@ -1071,7 +1071,7 @@ from the new routing resource.
     :doc:`FrameworkExtraBundle documentation </bundles/SensioFrameworkExtraBundle/annotations/routing>`
     to see how.
 
-Adding a Host requirement to Imported Routes
+Adding a Host Requirement to Imported Routes
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. versionadded:: 2.2
@@ -1253,8 +1253,8 @@ method::
     $this->generateUrl('blog_show', array('slug' => 'my-blog-post'), true);
     // http://www.example.com/blog/my-blog-post
 
-From a template, in Twig, simply use the ``url()`` function (which generates an absolute URL) 
-rather than the ``path()`` function (which generates a relative URL). In PHP, pass ``true`` 
+From a template, in Twig, simply use the ``url()`` function (which generates an absolute URL)
+rather than the ``path()`` function (which generates a relative URL). In PHP, pass ``true``
 to ``generateUrl()``:
 
 .. configuration-block::

diff --git a/book/security.rst b/book/security.rst
@@ -570,7 +570,7 @@ see :doc:`/cookbook/security/form_login`.
 
 .. _book-security-common-pitfalls:
 
-.. sidebar:: Avoid Common Pitfalls
+.. sidebar:: Avoid common Pitfalls
 
     When setting up your login form, watch out for a few common pitfalls.
 
@@ -713,7 +713,7 @@ In this section, you'll focus on how to secure different resources (e.g. URLs,
 method calls, etc) with different roles. Later, you'll learn more about how
 roles are created and assigned to users.
 
-Securing Specific URL Patterns
+Securing specific URL Patterns
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The most basic way to secure part of your application is to secure an entire
@@ -763,7 +763,7 @@ You can define as many URL patterns as you need - each is a regular expression.
 
 .. _security-book-access-control-explanation:
 
-Understanding how ``access_control`` works
+Understanding how ``access_control`` Works
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 For each incoming request, Symfony2 checks each ``access_control`` entry
@@ -1025,7 +1025,7 @@ In the previous sections, you learned how you can protect different resources
 by requiring a set of *roles* for a resource. This section explores
 the other side of authorization: users.
 
-Where do Users come from? (*User Providers*)
+Where do Users Come from? (*User Providers*)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 During authentication, the user submits a set of credentials (usually a username
@@ -1390,7 +1390,7 @@ method:
 
         <p>Username: <?php echo $app->getUser()->getUsername() ?></p>
 
-Using Multiple User Providers
+Using multiple User Providers
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Each authentication mechanism (e.g. HTTP Authentication, form login, etc)
@@ -1671,7 +1671,7 @@ the built-in helper function:
     idea to have a main firewall that covers all URLs (as has been shown
     in this chapter).
 
-Access Control Lists (ACLs): Securing Individual Database Objects
+Access Control Lists (ACLs): Securing individual Database Objects
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Imagine you are designing a blog system where your users can comment on your
@@ -1868,7 +1868,7 @@ algorithm; you can use the same strategy in your own code thanks to the
     // is password1 equals to password2?
     $bool = StringUtils::equals($password1, $password2);
 
-Generating a secure Random Number
+Generating a secure random Number
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Whenever you need to generate a secure random number, you are highly

diff --git a/book/service_container.rst b/book/service_container.rst
@@ -762,7 +762,7 @@ Injecting the dependency by the setter method just needs a change of syntax:
     and "setter injection". The Symfony2 service container also supports
     "property injection".
 
-Making References Optional
+Making References optional
 --------------------------
 
 Sometimes, one of your services may have an optional dependency, meaning

diff --git a/book/templating.rst b/book/templating.rst
@@ -1,7 +1,7 @@
 .. index::
    single: Templating
 
-Creating and using Templates
+Creating and Using Templates
 ============================
 
 As you know, the :doc:`controller </book/controller>` is responsible for
@@ -1129,7 +1129,7 @@ automatically:
 .. index::
    single: Templating; The templating service
 
-Configuring and using the ``templating`` Service
+Configuring and Using the ``templating`` Service
 ------------------------------------------------
 
 The heart of the template system in Symfony2 is the templating ``Engine``.

diff --git a/book/testing.rst b/book/testing.rst
@@ -229,7 +229,7 @@ document::
 
 .. _book-testing-request-method-sidebar:
 
-.. sidebar:: More about the ``request()`` method:
+.. sidebar:: More about the ``request()`` Method:
 
     The full signature of the ``request()`` method is::
 
@@ -404,7 +404,7 @@ The Client supports many operations that can be done in a real browser::
     // Clears all cookies and the history
     $client->restart();
 
-Accessing Internal Objects
+Accessing internal Objects
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. versionadded:: 2.3

diff --git a/book/translation.rst b/book/translation.rst
@@ -499,7 +499,7 @@ as the locale for the current request.
 You can now use the locale to create routes to other translated pages
 in your application.
 
-Setting a Default Locale
+Setting a default Locale
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
 What if the user's locale hasn't been determined? You can guarantee that a

diff --git a/quick_tour/the_big_picture.rst b/quick_tour/the_big_picture.rst
@@ -318,7 +318,7 @@ environment.
 
 .. _quick-tour-big-picture-environments-intro:
 
-What Is an environment?
+What is an Environment?
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 An :term:`Environment` represents a group of configurations that's used to run
@@ -378,4 +378,4 @@ are eager to learn more about Symfony2, dive into the next section:
 
 .. _Composer:             https://getcomposer.org/
 .. _executable installer: http://getcomposer.org/download
-.. _Twig:                 http://twig.sensiolabs.org/
+.. _Twig:                 http://twig.sensiolabs.org/
diff --git a/quick_tour/the_controller.rst b/quick_tour/the_controller.rst
@@ -105,7 +105,7 @@ Symfony will transform it into a proper ``500`` error page::
 
     throw new \Exception('Something went wrong!');
 
-Getting information from the Request
+Getting Information from the Request
 ------------------------------------
 
 Symfony automatically injects the ``Request`` object when the controller has an

diff --git a/quick_tour/the_view.rst b/quick_tour/the_view.rst
@@ -244,8 +244,8 @@ parameters are the values of the variables defined in the route pattern::
     *absolute* URLs, which is very handy when rendering emails and RSS files:
     ``{{ url('_demo_hello', {'name': 'Thomas'}) }}``.
 
-Including Assets: images, JavaScripts, and stylesheets
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Including Assets: Images, JavaScripts and Stylesheets
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 What would the Internet be without images, JavaScripts, and stylesheets?
 Symfony2 provides the ``asset`` function to deal with them easily:

diff --git a/reference/configuration/assetic.rst b/reference/configuration/assetic.rst
@@ -1,10 +1,10 @@
 .. index::
-   pair: Assetic; Configuration reference
+    pair: Assetic; Configuration reference
 
 AsseticBundle Configuration ("assetic")
 =======================================
 
-Full Default Configuration
+Full default Configuration
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. configuration-block::

diff --git a/reference/configuration/doctrine.rst b/reference/configuration/doctrine.rst
@@ -1,10 +1,13 @@
 .. index::
-   single: Doctrine; ORM configuration reference
-   single: Configuration reference; Doctrine ORM
+    single: Doctrine; ORM configuration reference
+    single: Configuration reference; Doctrine ORM
 
 DoctrineBundle Configuration ("doctrine")
 =========================================
 
+Full default configuration
+--------------------------
+
 .. configuration-block::
 
     .. code-block:: yaml

diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst
@@ -1,5 +1,5 @@
 .. index::
-   single: Configuration reference; Framework
+    single: Configuration reference; Framework
 
 FrameworkBundle Configuration ("framework")
 ===========================================
@@ -439,7 +439,7 @@ and activate the data collectors by hand::
 
     $profiler->enable();
 
-Full Default Configuration
+Full default Configuration
 --------------------------
 
 .. configuration-block::

diff --git a/reference/configuration/monolog.rst b/reference/configuration/monolog.rst
@@ -1,9 +1,12 @@
 .. index::
-   pair: Monolog; Configuration reference
+    pair: Monolog; Configuration reference
 
 MonologBundle Configuration ("monolog")
 =======================================
 
+Full default Configuration
+--------------------------
+
 .. configuration-block::
 
     .. code-block:: yaml