Permalink
Browse files

README updated, typos in doc files corrected, image file added

  • Loading branch information...
1 parent 691771e commit d5e264ab8649e975635bca22fa2c681943efe997 Peter Kokot committed with rande Jan 2, 2012
View
@@ -5,7 +5,7 @@ This bundle integrates the SonataAdminBundle with the Doctrine ORM project.
The online documentation of the bundle is in http://sonata-project.org/bundles/doctrine-orm-admin
-For contribution to the documentation you cand find it on [Resources/doc]().
+For contribution to the documentation you cand find it on [Resources/doc](https://github.com/sonata-project/SonataDoctrineORMAdminBundle/tree/master/Resources/doc).
**Warning**: documentation files are not rendering correctly in Github (reStructuredText format)
and some content might be broken or hidden, make sure to read raw files.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
@@ -3,8 +3,8 @@ Audit
The bundle provides a support for the ``EntityAuditBundle`` from https://github.com/simplethings/EntityAudit.
-How it work
------------
+How it works
+------------
**Extract from the original documentation**
@@ -4,7 +4,7 @@ Filter Field Definition
These fields are displayed inside the filter box. They allow you to filter
the list of entities by a number of different methods.
-A filter instance is always linked to a Form Type, there is 3 types availables :
+A filter instance is always linked to a Form Type, there are 3 types available :
- sonata_type_filter_number : display 2 widgets, the operator ( >, >=, <= , <, =) and the value
- sonata_type_filter_choice : display 2 widgets, the operator (yes and no) and the value
@@ -22,17 +22,17 @@ The ``add`` method accepts 4 arguments :
- the field type : the type of widget used to render the value part
- the field options : the type options
-Type available
----------------
+Filter types available
+----------------------
For now, only Doctrine ORM filters are available
- - doctrine_orm_boolean : depends on the ``sonata_type_filter_default`` Form Type, render yes or no field
+ - doctrine_orm_boolean : depends on the ``sonata_type_filter_default`` Form Type, renders yes or no field
- doctrine_orm_callback : depends on the ``sonata_type_filter_default`` Form Type, types can be configured as needed
- - doctrine_orm_choice : depends on the ``sonata_type_filter_choice`` Form Type, render yes or no field
+ - doctrine_orm_choice : depends on the ``sonata_type_filter_choice`` Form Type, renders yes or no field
- doctrine_orm_model : depends on the ``sonata_type_filter_number`` Form Type
- doctrine_orm_string : depends on the ``sonata_type_filter_choice``
- - doctrine_orm_number : depends on the ``sonata_type_filter_choice`` Form Type, render yes or no field
+ - doctrine_orm_number : depends on the ``sonata_type_filter_choice`` Form Type, renders yes or no field
Example
@@ -74,7 +74,7 @@ If no type is set, the Admin class will use the one set in the doctrine mapping
definition.
Advanced Usage: File Management
---------------------------------
+-------------------------------
If you want to use custom types from the Form framework you must use the
``addType`` method. (The ``add`` method uses the information provided by the
@@ -113,7 +113,7 @@ model definition).
method. Otherwise, the full path will be provided.
Advanced Usage: Many-to-one
-----------------------------
+---------------------------
If you have many ``Post``s linked to one ``User``, then the ``Post`` form should
display a ``User`` field.
@@ -162,7 +162,7 @@ With the ``standard`` and ``list`` options, you can create a new ``User`` by cli
}
Advanced Usage: One-to-many
-----------------------------
+---------------------------
Let's say you have a ``Gallery`` that links to some ``Media``s with a join table
``galleryHasMedias``. You can easily add a new ``galleryHasMedias`` row by
@@ -2,7 +2,7 @@ Form types and data transformers
================================
The AdminBundle is shipped with custom form types and data transfomers in order
-to handle the diffent model's workflows and lifecycle.
+to handle the different model's workflows and lifecycle.
Form types
----------
@@ -19,7 +19,7 @@ Form types
- ``sonata_type_immutable_array``: this type allows to edit a fixed array, like a settings array.
-Let's say, the object have a settings properties
+Let's say, the object has settings properties
.. code-block:: php
@@ -68,7 +68,7 @@ the output will be :
.. image:: ../images/sonata_type_immutable_array.png
:alt: Immutable Array Type
- :width: 200
+ :width: 460
Other options :
@@ -75,7 +75,7 @@ You can set actions for the list items by adding an '_action' field in ``configu
))
Edit and delete actions are enabled in the default configuration. You can add
-your own! Default template file is: ``SonataAdminBundle:CRUD:list__action_[ACTION_NAME].html.twig``
+your own! Default template file is: ``SonataAdminBundle:CRUD:list__action_[ACTION_NAME].html.twig``
You can specify your own by setting up the 'template' option like so:
@@ -6,8 +6,8 @@ The ``ProxyQuery`` object is used to add missing features from the original Doct
- ``execute`` method - no need to call the ``getQuery()`` method
- add sort by and sort order options
- - add preselect id query on left join query, so a limit query will be only apply on the left statement and
- not on the full select statement. This simulate the original Doctrine 1 behavior.
+ - add preselect id query on left join query, so a limit query will be only applied on the left statement and
+ not on the full select statement. This simulates the original Doctrine 1 behavior.
.. code-block:: php
@@ -23,5 +23,4 @@ The ``ProxyQuery`` object is used to add missing features from the original Doct
$proxyQuery->setSortBy('name');
$proxyQuery->setMaxResults(10);
-
$results = $proxyQuery->execute();
@@ -11,7 +11,7 @@ You can customize the global layout by tweaking the ``SonataAdminBundle`` config
layout: SonataAdminBundle::standard_layout.html.twig
ajax: SonataAdminBundle::ajax_layout.html.twig
- # default value if done set, actions templates, should extends a global templates
+ # default value if done set, actions templates, should extend global templates
list: SonataAdminBundle:CRUD:list.html.twig
show: SonataAdminBundle:CRUD:show.html.twig
edit: SonataAdminBundle:CRUD:edit.html.twig
@@ -65,5 +65,5 @@ You can also customize field types by adding types in the ``config.yml`` file. T
.. note::
- By default, if the ``SonataIntlBundle`` classes are availables, then the numeric and date fields will be
- localized with the current user locale.
+ By default, if the ``SonataIntlBundle`` classes are available, then the numeric and date fields will be
+ localized with the current user locale.
@@ -139,7 +139,7 @@ dashboard and interact with the CRUD interface. Following this however, you will
need to create an admin Controller.
This interface will display too many fields as some of them are not relevant to
-a general overview. Next We'll see how to specify the fields we want to use and
+a general overview. Next we'll see how to specify the fields we want to use and
how we want to use them.
So same goes for the TagAdmin and CommentAdmin class.

0 comments on commit d5e264a

Please sign in to comment.