From 0702d1fc1df6ed4a0ccce4d6517090330528a2ea Mon Sep 17 00:00:00 2001 From: Christian Flothmann Date: Sun, 6 Apr 2014 12:30:40 +0200 Subject: [PATCH 1/3] [Book] make headlines consistent with our standards --- book/doctrine.rst | 6 +++--- book/forms.rst | 4 ++-- book/from_flat_php_to_symfony2.rst | 4 ++-- book/http_cache.rst | 4 ++-- book/http_fundamentals.rst | 6 +++--- book/internals.rst | 4 ++-- book/propel.rst | 4 ++-- book/routing.rst | 6 +++--- book/security.rst | 14 +++++++------- book/service_container.rst | 2 +- book/templating.rst | 4 ++-- book/testing.rst | 4 ++-- book/translation.rst | 2 +- 13 files changed, 32 insertions(+), 32 deletions(-) diff --git a/book/doctrine.rst b/book/doctrine.rst index c65483c9561..29a4c429259 100644 --- 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 index 6d29811b73f..f12133bd919 100644 --- 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 index 02c456d3e15..f40477b02c3 100644 --- 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 index 7a989805178..ea40f66ee08 100644 --- 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 index 7e376257b63..fa0d80e57fb 100644 --- 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 index c440a377593..5d75c952912 100644 --- 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 index 3023c17da9c..6b239374e64 100644 --- 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 index 42a96c4fb77..6c0fef9be6a 100644 --- a/book/routing.rst +++ b/book/routing.rst @@ -1071,7 +1071,7 @@ from the new routing resource. :doc:`FrameworkExtraBundle documentation ` 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 index b1e7aebbe75..9e38f4833ea 100644 --- 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:

Username: getUser()->getUsername() ?>

-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 index 29248f6d60b..a92ecfb5982 100644 --- 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 index ea240e8941b..fb411144ab2 100644 --- 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 ` 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 index 4d1a635d08f..c892fb057cb 100644 --- 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 index 683fbe83794..ad6a902e81c 100644 --- 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 From d49d12eaf265a5d6d32ac660c62f385d57261475 Mon Sep 17 00:00:00 2001 From: Christian Flothmann Date: Sat, 12 Apr 2014 11:00:23 +0200 Subject: [PATCH 2/3] [Reference] consistent headlines --- reference/configuration/assetic.rst | 4 ++-- reference/configuration/doctrine.rst | 7 +++++-- reference/configuration/framework.rst | 4 ++-- reference/configuration/monolog.rst | 5 ++++- reference/configuration/security.rst | 6 +++--- reference/configuration/swiftmailer.rst | 6 +++--- reference/configuration/twig.rst | 2 +- reference/configuration/web_profiler.rst | 4 ++-- reference/constraints/CardScheme.rst | 6 +++--- reference/constraints/Collection.rst | 8 ++++---- reference/forms/types/birthday.rst | 4 ++-- reference/forms/types/button.rst | 2 +- reference/forms/types/checkbox.rst | 4 ++-- reference/forms/types/choice.rst | 8 ++++---- reference/forms/types/collection.rst | 4 ++-- reference/forms/types/country.rst | 2 +- reference/forms/types/currency.rst | 2 +- reference/forms/types/date.rst | 2 +- reference/forms/types/datetime.rst | 2 +- reference/forms/types/entity.rst | 12 ++++++------ reference/forms/types/file.rst | 4 ++-- reference/forms/types/form.rst | 6 +++--- reference/forms/types/integer.rst | 2 +- reference/forms/types/locale.rst | 2 +- .../forms/types/options/select_how_rendered.rst.inc | 4 ++-- reference/forms/types/percent.rst | 6 +++--- reference/forms/types/repeated.rst | 2 +- reference/forms/types/reset.rst | 2 +- reference/forms/types/submit.rst | 4 ++-- reference/forms/types/time.rst | 2 +- reference/forms/types/timezone.rst | 2 +- reference/requirements.rst | 4 ++-- 32 files changed, 70 insertions(+), 64 deletions(-) diff --git a/reference/configuration/assetic.rst b/reference/configuration/assetic.rst index c152d5c3f82..f85346394a8 100644 --- 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 index adbb0bd6d3c..9c9b959123a 100644 --- 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 index 7008ecc8c0d..d0181c56408 100644 --- 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 index 24365fbd682..7ecb10bdc62 100644 --- 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 diff --git a/reference/configuration/security.rst b/reference/configuration/security.rst index 121cccffcd3..ceb9fa2bbe5 100644 --- a/reference/configuration/security.rst +++ b/reference/configuration/security.rst @@ -1,5 +1,5 @@ .. index:: - single: Security; Configuration reference + single: Security; Configuration reference SecurityBundle Configuration ("security") ========================================= @@ -7,7 +7,7 @@ SecurityBundle Configuration ("security") The security system is one of the most powerful parts of Symfony2, and can largely be controlled via its configuration. -Full Default Configuration +Full default Configuration -------------------------- The following is the full default configuration for the security system. @@ -281,7 +281,7 @@ Redirecting after Login .. _reference-security-pbkdf2: -Using the PBKDF2 encoder: Security and Speed +Using the PBKDF2 Encoder: Security and Speed -------------------------------------------- .. versionadded:: 2.2 diff --git a/reference/configuration/swiftmailer.rst b/reference/configuration/swiftmailer.rst index ee6c625b5cc..77304dff4f2 100644 --- a/reference/configuration/swiftmailer.rst +++ b/reference/configuration/swiftmailer.rst @@ -1,5 +1,5 @@ .. index:: - single: Configuration reference; Swift Mailer + single: Configuration reference; Swift Mailer SwiftmailerBundle Configuration ("swiftmailer") =============================================== @@ -172,7 +172,7 @@ logging If true, Symfony's data collector will be activated for Swift Mailer and the information will be available in the profiler. -Full Default Configuration +Full default Configuration -------------------------- .. configuration-block:: @@ -224,7 +224,7 @@ Full Default Configuration /> -Using Multiple Mailers +Using multiple Mailers ---------------------- You can configure multiple mailers by grouping them under the ``mailers`` diff --git a/reference/configuration/twig.rst b/reference/configuration/twig.rst index c8401d8dfa5..cdb3de3bd00 100644 --- a/reference/configuration/twig.rst +++ b/reference/configuration/twig.rst @@ -1,5 +1,5 @@ .. index:: - pair: Twig; Configuration reference + pair: Twig; Configuration reference TwigBundle Configuration ("twig") ================================= diff --git a/reference/configuration/web_profiler.rst b/reference/configuration/web_profiler.rst index 5bc81fc9704..50ad25c9043 100644 --- a/reference/configuration/web_profiler.rst +++ b/reference/configuration/web_profiler.rst @@ -1,10 +1,10 @@ .. index:: - single: Configuration reference; WebProfiler + single: Configuration reference; WebProfiler WebProfilerBundle Configuration ("web_profiler") ================================================ -Full Default Configuration +Full default Configuration -------------------------- .. configuration-block:: diff --git a/reference/constraints/CardScheme.rst b/reference/constraints/CardScheme.rst index 7c4109e418b..c163dd1f2e3 100644 --- a/reference/constraints/CardScheme.rst +++ b/reference/constraints/CardScheme.rst @@ -61,7 +61,7 @@ on an object that will contain a credit card number. // src/Acme/SubscriptionBundle/Entity/Transaction.php namespace Acme\SubscriptionBundle\Entity\Transaction; - + use Symfony\Component\Validator\Constraints as Assert; class Transaction @@ -76,7 +76,7 @@ on an object that will contain a credit card number. // src/Acme/SubscriptionBundle/Entity/Transaction.php namespace Acme\SubscriptionBundle\Entity\Transaction; - + use Symfony\Component\Validator\Mapping\ClassMetadata; use Symfony\Component\Validator\Constraints as Assert; @@ -99,7 +99,7 @@ Available Options ----------------- schemes -------- +~~~~~~~ **type**: ``mixed`` [:ref:`default option `] diff --git a/reference/constraints/Collection.rst b/reference/constraints/Collection.rst index 5363760823d..1badcf050f8 100644 --- a/reference/constraints/Collection.rst +++ b/reference/constraints/Collection.rst @@ -169,7 +169,7 @@ the above example, the ``allowMissingFields`` option was set to true, meaning that if either of the ``personal_email`` or ``short_bio`` elements were missing from the ``$personalData`` property, no validation error would occur. -Required and Optional Field Constraints +Required and optional Field Constraints ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. versionadded:: 2.3 @@ -187,7 +187,7 @@ field is optional but must be a valid email if supplied, you can do the followin .. configuration-block:: .. code-block:: yaml - + # src/Acme/BlogBundle/Resources/config/validation.yml Acme\BlogBundle\Entity\Author: properties: @@ -223,9 +223,9 @@ field is optional but must be a valid email if supplied, you can do the followin 'personal_email', ); } - + .. code-block:: xml - + ` type: .. include:: /reference/forms/types/options/date_widget.rst.inc - + .. include:: /reference/forms/types/options/date_input.rst.inc .. include:: /reference/forms/types/options/empty_value.rst.inc diff --git a/reference/forms/types/button.rst b/reference/forms/types/button.rst index 0d6a17feeab..67d8bef4055 100644 --- a/reference/forms/types/button.rst +++ b/reference/forms/types/button.rst @@ -22,7 +22,7 @@ A simple, non-responsive button. | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\ButtonType` | +----------------------+----------------------------------------------------------------------+ -Inherited options +Inherited Options ----------------- The following options are defined in the diff --git a/reference/forms/types/checkbox.rst b/reference/forms/types/checkbox.rst index 546a5bc9933..69c4fee5199 100644 --- a/reference/forms/types/checkbox.rst +++ b/reference/forms/types/checkbox.rst @@ -46,14 +46,14 @@ Field Options .. include:: /reference/forms/types/options/value.rst.inc -Overridden options +Overridden Options ------------------ .. include:: /reference/forms/types/options/checkbox_empty_data.rst.inc .. include:: /reference/forms/types/options/checkbox_compound.rst.inc -Inherited options +Inherited Options ----------------- These options inherit from the :doc:`form ` type: diff --git a/reference/forms/types/choice.rst b/reference/forms/types/choice.rst index 4cc88ed5f50..f7e298ec0aa 100644 --- a/reference/forms/types/choice.rst +++ b/reference/forms/types/choice.rst @@ -111,7 +111,7 @@ can be created to supply the choices. .. include:: /reference/forms/types/options/empty_value.rst.inc -Overridden options +Overridden Options ------------------ .. include:: /reference/forms/types/options/empty_data.rst.inc @@ -121,7 +121,7 @@ compound **type**: ``boolean`` **default**: same value as ``expanded`` option -This option specifies if a form is compound. The value is by default +This option specifies if a form is compound. The value is by default overridden by the value of the ``expanded`` option. error_bubbling @@ -129,10 +129,10 @@ error_bubbling **type**: ``boolean`` **default**: ``false`` -Set that error on this field must be attached to the field instead of +Set that error on this field must be attached to the field instead of the parent field (the form in most cases). -Inherited options +Inherited Options ----------------- These options inherit from the :doc:`form ` type: diff --git a/reference/forms/types/collection.rst b/reference/forms/types/collection.rst index 71174e51ede..fc8aecd01ae 100644 --- a/reference/forms/types/collection.rst +++ b/reference/forms/types/collection.rst @@ -112,7 +112,7 @@ existing addresses. Adding new addresses is possible by using the `allow_add`_ option (and optionally the `prototype`_ option) (see example below). Removing emails from the ``emails`` array is possible with the `allow_delete`_ option. -Adding and Removing items +Adding and Removing Items ~~~~~~~~~~~~~~~~~~~~~~~~~ If `allow_add`_ is set to ``true``, then if any unrecognized items are submitted, @@ -336,7 +336,7 @@ If you have several collections in your form, or worse, nested collections you may want to change the placeholder so that unrelated placeholders are not replaced with the same value. -Inherited options +Inherited Options ----------------- These options inherit from the :doc:`form ` type. diff --git a/reference/forms/types/country.rst b/reference/forms/types/country.rst index e8bb61ae572..700e4adb6c6 100644 --- a/reference/forms/types/country.rst +++ b/reference/forms/types/country.rst @@ -56,7 +56,7 @@ choices The country type defaults the ``choices`` option to the whole list of countries. The locale is used to translate the countries names. -Inherited options +Inherited Options ----------------- These options inherit from the :doc:`choice ` type: diff --git a/reference/forms/types/currency.rst b/reference/forms/types/currency.rst index b91b55f5a48..ba7597bf564 100644 --- a/reference/forms/types/currency.rst +++ b/reference/forms/types/currency.rst @@ -48,7 +48,7 @@ choices The choices option defaults to all currencies. -Inherited options +Inherited Options ----------------- These options inherit from the :doc:`choice` type: diff --git a/reference/forms/types/date.rst b/reference/forms/types/date.rst index 92459cb2de4..d7b60bf9230 100644 --- a/reference/forms/types/date.rst +++ b/reference/forms/types/date.rst @@ -134,7 +134,7 @@ error_bubbling **default**: ``false`` -Inherited options +Inherited Options ----------------- These options inherit from the :doc:`form ` type: diff --git a/reference/forms/types/datetime.rst b/reference/forms/types/datetime.rst index 4abc048ee5f..111bf1220d3 100644 --- a/reference/forms/types/datetime.rst +++ b/reference/forms/types/datetime.rst @@ -132,7 +132,7 @@ field to be rendered as an ``input`` field with ``type="datetime"``. .. include:: /reference/forms/types/options/empty_value.rst.inc -Inherited options +Inherited Options ----------------- These options inherit from the :doc:`form ` type: diff --git a/reference/forms/types/entity.rst b/reference/forms/types/entity.rst index f43cd7c9363..e68cf6718d6 100644 --- a/reference/forms/types/entity.rst +++ b/reference/forms/types/entity.rst @@ -120,11 +120,11 @@ cast into a string and so must have a ``__toString()`` method. .. note:: - The ``property`` option is the property path used to display the option. So you + The ``property`` option is the property path used to display the option. So you can use anything supported by the :doc:`PropertyAccessor component ` - For example, if the translations property is actually an associative array of + For example, if the translations property is actually an associative array of objects, each with a name property, then you could do this:: $builder->add('gender', 'entity', array( @@ -184,7 +184,7 @@ for you, by using all of the above options. If you need to override this option, you may just consider using the :doc:`/reference/forms/types/choice` directly. -Inherited options +Inherited Options ----------------- These options inherit from the :doc:`choice ` type: @@ -192,18 +192,18 @@ These options inherit from the :doc:`choice ` typ .. include:: /reference/forms/types/options/multiple.rst.inc .. note:: - + If you are working with a collection of Doctrine entities, it will be helpful to read the documentation for the :doc:`/reference/forms/types/collection` as well. In addition, there is a complete example in the cookbook article :doc:`/cookbook/form/form_collections`. - + .. include:: /reference/forms/types/options/expanded.rst.inc .. include:: /reference/forms/types/options/preferred_choices.rst.inc .. note:: - + This option expects an array of entity objects, unlike the ``choice`` field that requires an array of keys. diff --git a/reference/forms/types/file.rst b/reference/forms/types/file.rst index 6b88b14b1e3..32c718f3a8c 100644 --- a/reference/forms/types/file.rst +++ b/reference/forms/types/file.rst @@ -78,7 +78,7 @@ before using it directly. Read the :doc:`cookbook ` for an example of how to manage a file upload associated with a Doctrine entity. -Inherited options +Inherited Options ----------------- These options inherit from the :doc:`form ` type: @@ -105,7 +105,7 @@ Form Variables -------------- ======== ========== =============================================================================== -Variable Type Usage +Variable Type Usage ======== ========== =============================================================================== type ``string`` The type variable is set to ``file``, in order to render as a file input field. ======== ========== =============================================================================== diff --git a/reference/forms/types/form.rst b/reference/forms/types/form.rst index 38416d12aa9..fa00b60ffcd 100644 --- a/reference/forms/types/form.rst +++ b/reference/forms/types/form.rst @@ -43,8 +43,8 @@ on all types for which ``form`` is the parent type. | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\FormType` | +-----------+--------------------------------------------------------------------+ -Options -------- +Field Options +------------- .. include:: /reference/forms/types/options/data.rst.inc @@ -104,7 +104,7 @@ Options .. include:: /reference/forms/types/options/method.rst.inc -Inherited options +Inherited Options ----------------- The following options are defined in the diff --git a/reference/forms/types/integer.rst b/reference/forms/types/integer.rst index a92ae6697df..14add652997 100644 --- a/reference/forms/types/integer.rst +++ b/reference/forms/types/integer.rst @@ -65,7 +65,7 @@ on the :class:`Symfony\\Component\\Form\\Extension\\Core\\DataTransformer\\Integ .. include:: /reference/forms/types/options/grouping.rst.inc -Inherited options +Inherited Options ----------------- These options inherit from the :doc:`form ` type: diff --git a/reference/forms/types/locale.rst b/reference/forms/types/locale.rst index c5626f71b95..56b588662aa 100644 --- a/reference/forms/types/locale.rst +++ b/reference/forms/types/locale.rst @@ -59,7 +59,7 @@ choices The choices option defaults to all locales. It uses the default locale to specify the language. -Inherited options +Inherited Options ----------------- These options inherit from the :doc:`choice ` type: diff --git a/reference/forms/types/options/select_how_rendered.rst.inc b/reference/forms/types/options/select_how_rendered.rst.inc index 540a332ec2c..cb785e18f54 100644 --- a/reference/forms/types/options/select_how_rendered.rst.inc +++ b/reference/forms/types/options/select_how_rendered.rst.inc @@ -1,4 +1,4 @@ -Select tag, Checkboxes or Radio Buttons +Select Tag, Checkboxes or Radio Buttons --------------------------------------- This field may be rendered as one of several different HTML fields, depending @@ -14,4 +14,4 @@ on the ``expanded`` and ``multiple`` options: | radio buttons | true | false | +------------------------------------------+----------+----------+ | checkboxes | true | true | -+------------------------------------------+----------+----------+ \ No newline at end of file ++------------------------------------------+----------+----------+ diff --git a/reference/forms/types/percent.rst b/reference/forms/types/percent.rst index dbde292cc35..c1c2b673ac0 100644 --- a/reference/forms/types/percent.rst +++ b/reference/forms/types/percent.rst @@ -36,8 +36,8 @@ This field adds a percentage sign "``%``" after the input box. | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\PercentType` | +-------------+-----------------------------------------------------------------------+ -Options -------- +Field Options +------------- type ~~~~ @@ -47,7 +47,7 @@ type This controls how your data is stored on your object. For example, a percentage corresponding to "55%", might be stored as ``.55`` or ``55`` on your object. The two "types" handle these two cases: - + * ``fractional`` If your data is stored as a decimal (e.g. ``.55``), use this type. The data will be multiplied by ``100`` before being shown to the diff --git a/reference/forms/types/repeated.rst b/reference/forms/types/repeated.rst index fbdb5dd5fb7..12262eaae17 100644 --- a/reference/forms/types/repeated.rst +++ b/reference/forms/types/repeated.rst @@ -178,7 +178,7 @@ error_bubbling **default**: ``false`` -Inherited options +Inherited Options ----------------- These options inherit from the :doc:`form ` type: diff --git a/reference/forms/types/reset.rst b/reference/forms/types/reset.rst index bf5c62cf280..20b2d9dad70 100644 --- a/reference/forms/types/reset.rst +++ b/reference/forms/types/reset.rst @@ -23,7 +23,7 @@ A button that resets all fields to their original values. | Class | :class:`Symfony\\Component\\Form\\Extension\\Core\\Type\\ResetType` | +----------------------+---------------------------------------------------------------------+ -Inherited options +Inherited Options ----------------- .. include:: /reference/forms/types/options/button_attr.rst.inc diff --git a/reference/forms/types/submit.rst b/reference/forms/types/submit.rst index ec68f4b84bd..3b98e68c176 100644 --- a/reference/forms/types/submit.rst +++ b/reference/forms/types/submit.rst @@ -32,7 +32,7 @@ useful when :ref:`a form has multiple submit buttons ` type: diff --git a/reference/forms/types/timezone.rst b/reference/forms/types/timezone.rst index 6867e89a8e0..89ca811e3fb 100644 --- a/reference/forms/types/timezone.rst +++ b/reference/forms/types/timezone.rst @@ -52,7 +52,7 @@ choice_list The Timezone type defaults the choice_list to all timezones returned by :phpmethod:`DateTimeZone::listIdentifiers`, broken down by continent. -Inherited options +Inherited Options ----------------- These options inherit from the :doc:`choice ` type: diff --git a/reference/requirements.rst b/reference/requirements.rst index 4ac671319d6..712a00e8f63 100644 --- a/reference/requirements.rst +++ b/reference/requirements.rst @@ -1,7 +1,7 @@ .. index:: single: Requirements - -Requirements for running Symfony2 + +Requirements for Running Symfony2 ================================= To run Symfony2, your system needs to adhere to a list of requirements. You can From 1d2a6205ba35ad0838ead90ffbf4383748833f12 Mon Sep 17 00:00:00 2001 From: Christian Flothmann Date: Sat, 12 Apr 2014 11:25:30 +0200 Subject: [PATCH 3/3] [QuickTour] consistent headlines --- quick_tour/the_big_picture.rst | 4 ++-- quick_tour/the_controller.rst | 2 +- quick_tour/the_view.rst | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/quick_tour/the_big_picture.rst b/quick_tour/the_big_picture.rst index be3170cdcef..eb98595f979 100644 --- 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/ \ No newline at end of file +.. _Twig: http://twig.sensiolabs.org/ diff --git a/quick_tour/the_controller.rst b/quick_tour/the_controller.rst index 35e740241d1..edb5124faaa 100644 --- 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 index b7de6aab165..1dc675538ec 100644 --- 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: