Browse Source

Fixed formating in translation.rst
Removed reference to bc strategy
Added example to the paragraph at the end
( Closes #1534 )

Christian Morgan 12 years ago
parent
commit
58da928105
1 changed files with 38 additions and 36 deletions
  1. 38 36
      Resources/doc/reference/translation.rst

+ 38 - 36
Resources/doc/reference/translation.rst

@@ -15,29 +15,29 @@ You have two options to configure the catalogue for the Admin class:
 
 * by over-riding the ``$translationDomain`` property
 
-    .. code-block:: php
+  .. code-block:: php
 
-        <?php
-        class PageAdmin extends Admin
-        {
-            protected $translationDomain = 'SonataPageBundle'; // default is 'messages'
-        }
+      <?php
+      class PageAdmin extends Admin
+      {
+          protected $translationDomain = 'SonataPageBundle'; // default is 'messages'
+      }
 
 
 * or by injecting the value through the container
 
-    .. code-block:: xml
+  .. code-block:: xml
 
-            <service id="sonata.page.admin.page" class="Sonata\PageBundle\Admin\PageAdmin">
-                <tag name="sonata.admin" manager_type="orm" group="sonata_page" label="page"/>
-                <argument />
-                <argument>Application\Sonata\PageBundle\Entity\Page</argument>
-                <argument />
+          <service id="sonata.page.admin.page" class="Sonata\PageBundle\Admin\PageAdmin">
+              <tag name="sonata.admin" manager_type="orm" group="sonata_page" label="page"/>
+              <argument />
+              <argument>Application\Sonata\PageBundle\Entity\Page</argument>
+              <argument />
 
-                <call method="setTranslationDomain">
-                    <argument>SonataPageBundle</argument>
-                </call>
-            </service>
+              <call method="setTranslationDomain">
+                  <argument>SonataPageBundle</argument>
+              </call>
+          </service>
 
 
 An Admin instance always gets the ``translator`` instance, so it can be used to
@@ -81,24 +81,24 @@ Setting the translation domain on an individual field:
 
 .. code-block:: php
 
-        $formMapper->with('form.my_group')
-            ->add('publishable', 'checkbox', array(), array(
-                'translation_domain' => 'MyTranslationDomain',
-            ))
-        ;
+    $formMapper->with('form.my_group')
+        ->add('publishable', 'checkbox', array(), array(
+            'translation_domain' => 'MyTranslationDomain',
+        ))
+    ;
 
 The following example sets the default translation domain on a form group and 
 over-rides that setting for one of the fields:
 
 .. code-block:: php
 
-        $formMapper
-            ->with('form.my_group', array('translation_domain' => 'MyDomain'))
-                ->add('publishable', 'checkbox', array(), array(
-                    'translation_domain' => 'AnotherDomain',
-                ))
-                ->add('start_date', 'date', array(), array())
-        ;
+    $formMapper
+        ->with('form.my_group', array('translation_domain' => 'MyDomain'))
+            ->add('publishable', 'checkbox', array(), array(
+                'translation_domain' => 'AnotherDomain',
+            ))
+            ->add('start_date', 'date', array(), array())
+    ;
 
 Setting the label name
 ^^^^^^^^^^^^^^^^^^^^^^
@@ -128,24 +128,25 @@ There is another option for rapid prototyping or to avoid spending too much time
 adding the ``label`` key to all option fields: **Label Strategies**. By default
 labels are generated by using a simple rule:
 
+.. code-block
+
     isValid => Is Valid
 
+
 The ``AdminBundle`` comes with different key label generation strategies:
 
-* ``sonata.admin.label.strategy.native``: DEFAULT - Makes the string human 
+- ``sonata.admin.label.strategy.native``: DEFAULT - Makes the string human 
   readable
     ``isValid`` => ``Is Valid``
-* ``sonata.admin.label.strategy.form_component``: The default behavior from the Form 
+- ``sonata.admin.label.strategy.form_component``: The default behavior from the Form 
   Component
     ``isValid`` => ``Isvalid``
-* ``sonata.admin.label.strategy.underscore``: Changes the name into a token suitable for 
+- ``sonata.admin.label.strategy.underscore``: Changes the name into a token suitable for 
   translation by prepending "form.label" to an underscored version of the field name
     ``isValid`` => ``form.label_is_valid``
-* ``sonata.admin.label.strategy.noop``: does not alter the 
+- ``sonata.admin.label.strategy.noop``: does not alter the 
   string
     ``isValid`` => ``isValid``
-* ``sonata.admin.label.strategy.bc``: preserves the old label generation from the 
-  early version of ``SonataAdminBundle``
 
 ``sonata.admin.label.strategy.underscore`` will be better for i18n applications
 and ``sonata.admin.label.strategy.native`` will be better for native (single) language
@@ -180,5 +181,6 @@ the Container:
 
 .. note::
 
-    When the strategy method is called, a context (form, filter, list, show) and
-    a type (link, label, etc ...) arguments are passed.
+    When the strategy method is called, ``context`` (breadcrumb, datagrid, filter, 
+    form, list, show, etc.) and ``type`` (usually link or label) arguments are passed. 
+    For example, the call may look like: ``getLabel($label_key, 'breadcrumb', 'link')``