Skip to content

Commit

Permalink
[Reference] consistent headlines
Browse files Browse the repository at this point in the history
  • Loading branch information
xabbuh committed Apr 12, 2014
1 parent 0702d1f commit d49d12e
Show file tree
Hide file tree
Showing 32 changed files with 70 additions and 64 deletions.
4 changes: 2 additions & 2 deletions reference/configuration/assetic.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.. index::
pair: Assetic; Configuration reference
pair: Assetic; Configuration reference

AsseticBundle Configuration ("assetic")
=======================================

Full Default Configuration
Full default Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. configuration-block::
Expand Down
7 changes: 5 additions & 2 deletions reference/configuration/doctrine.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions reference/configuration/framework.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. index::
single: Configuration reference; Framework
single: Configuration reference; Framework

FrameworkBundle Configuration ("framework")
===========================================
Expand Down Expand Up @@ -439,7 +439,7 @@ and activate the data collectors by hand::

$profiler->enable();

Full Default Configuration
Full default Configuration
--------------------------

.. configuration-block::
Expand Down
5 changes: 4 additions & 1 deletion reference/configuration/monolog.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
.. index::
pair: Monolog; Configuration reference
pair: Monolog; Configuration reference

MonologBundle Configuration ("monolog")
=======================================

Full default Configuration
--------------------------

.. configuration-block::

.. code-block:: yaml
Expand Down
6 changes: 3 additions & 3 deletions reference/configuration/security.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
.. index::
single: Security; Configuration reference
single: Security; Configuration reference

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.
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions reference/configuration/swiftmailer.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. index::
single: Configuration reference; Swift Mailer
single: Configuration reference; Swift Mailer

SwiftmailerBundle Configuration ("swiftmailer")
===============================================
Expand Down Expand Up @@ -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::
Expand Down Expand Up @@ -224,7 +224,7 @@ Full Default Configuration
/>
</swiftmailer:config>
Using Multiple Mailers
Using multiple Mailers
----------------------

You can configure multiple mailers by grouping them under the ``mailers``
Expand Down
2 changes: 1 addition & 1 deletion reference/configuration/twig.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. index::
pair: Twig; Configuration reference
pair: Twig; Configuration reference

TwigBundle Configuration ("twig")
=================================
Expand Down
4 changes: 2 additions & 2 deletions reference/configuration/web_profiler.rst
Original file line number Diff line number Diff line change
@@ -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::
Expand Down
6 changes: 3 additions & 3 deletions reference/constraints/CardScheme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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;
Expand All @@ -99,7 +99,7 @@ Available Options
-----------------

schemes
-------
~~~~~~~

**type**: ``mixed`` [:ref:`default option <validation-default-option>`]

Expand Down
8 changes: 4 additions & 4 deletions reference/constraints/Collection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down Expand Up @@ -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
<!-- src/Acme/BlogBundle/Resources/config/validation.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
Expand Down
4 changes: 2 additions & 2 deletions reference/forms/types/birthday.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,13 @@ years
List of years available to the year field type. This option is only
relevant when the ``widget`` option is set to ``choice``.

Inherited options
Inherited Options
-----------------

These options inherit from the :doc:`date </reference/forms/types/date>` 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
Expand Down
2 changes: 1 addition & 1 deletion reference/forms/types/button.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions reference/forms/types/checkbox.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 </reference/forms/types/form>` type:
Expand Down
8 changes: 4 additions & 4 deletions reference/forms/types/choice.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -121,18 +121,18 @@ 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
~~~~~~~~~~~~~~

**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 </reference/forms/types/form>` type:
Expand Down
4 changes: 2 additions & 2 deletions reference/forms/types/collection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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 </reference/forms/types/form>` type.
Expand Down
2 changes: 1 addition & 1 deletion reference/forms/types/country.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 </reference/forms/types/choice>` type:
Expand Down
2 changes: 1 addition & 1 deletion reference/forms/types/currency.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ choices

The choices option defaults to all currencies.

Inherited options
Inherited Options
-----------------

These options inherit from the :doc:`choice</reference/forms/types/choice>` type:
Expand Down
2 changes: 1 addition & 1 deletion reference/forms/types/date.rst
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ error_bubbling

**default**: ``false``

Inherited options
Inherited Options
-----------------

These options inherit from the :doc:`form </reference/forms/types/form>` type:
Expand Down
2 changes: 1 addition & 1 deletion reference/forms/types/datetime.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 </reference/forms/types/form>` type:
Expand Down
12 changes: 6 additions & 6 deletions reference/forms/types/entity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 </components/property_access/introduction>`

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(
Expand Down Expand Up @@ -184,26 +184,26 @@ 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 </reference/forms/types/choice>` type:

.. 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.

Expand Down
4 changes: 2 additions & 2 deletions reference/forms/types/file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ before using it directly.
Read the :doc:`cookbook </cookbook/doctrine/file_uploads>` 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 </reference/forms/types/form>` type:
Expand All @@ -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.
======== ========== ===============================================================================
6 changes: 3 additions & 3 deletions reference/forms/types/form.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -104,7 +104,7 @@ Options

.. include:: /reference/forms/types/options/method.rst.inc

Inherited options
Inherited Options
-----------------

The following options are defined in the
Expand Down
Loading

0 comments on commit d49d12e

Please sign in to comment.