Permalink
Browse files

punctuation

  • Loading branch information...
greg0ire committed Nov 22, 2012
1 parent ceb7d46 commit 9e6c7f36a7236e2bfd7f97bd01381a522af8855f
View
@@ -2,8 +2,8 @@ BlockBundle
===========
The `BlockBundle <https://github.com/symfony-cmf/BlockBundle#readme>`_ provides integration with SonataBlockBundle.
-It assists you in managing fragments of contents, so called blocks. What the BlockBundle does is similar
-to what Twig does, but for blocks that are persisted in a DB. Thus the blocks can be made editable for an editor.
+It assists you in managing fragments of contents, so-called blocks. What the BlockBundle does is similar
+to what Twig does, but for blocks that are persisted in a DB. Thus, the blocks can be made editable for an editor.
Also the BlockBundle provides the logic to determine which block should be rendered on which pages.
The BlockBundle does not provide an editing functionality for blocks itself. However, you can find examples
@@ -64,7 +64,7 @@ The BlockBundle comes with four general purpose blocks:
* SimpleBlock: A simple block with nothing but a title and a field of hypertext. This would usually be what an editor edits directly, for example contact information
* ContainerBlock: A block that contains 0 to n child blocks
* ReferenceBlock: A block that references a block stored somewhere else in the content tree. For example you might want to refer parts of the contact information from the homepage
- * ActionBlock: A block that calls a Symfony2 action. "Why would I use this instead of directly calling the action from my template?" you might wonder. Well imagine the following case: You provide a block that renders teasers of your latest news. However, there is no rule where they should appear. Instead, your customer wants to decide himself on what pages this block is to be displayed. Providing an according ActionBlock, you allow your customer to do so without calling you to change some templates (over and over again!).
+ * ActionBlock: A block that calls a Symfony2 action. "Why would I use this instead of directly calling the action from my template?", you might wonder. Well imagine the following case: You provide a block that renders teasers of your latest news. However, there is no rule where they should appear. Instead, your customer wants to decide himself on what pages this block is to be displayed. Providing an according ActionBlock, you allow your customer to do so without calling you to change some templates (over and over again!).
Create your own blocks
----------------------
@@ -86,7 +86,7 @@ template stored in 'templateName'. You can again extend ``Sonata\BlockBundle\Blo
It is important, that the 'name' property of the service is called 'my_bundle.block.rss' (this makes
sure the relation between entity and service can be found).
-The last thing you need is to define the service in a config file. It is important, to tag your
+The last thing you need is to define the service in a config file. It is important to tag your
BlockService with 'sonata.block', otherwise it will not be known by the Bundle.
Examples
View
@@ -9,7 +9,7 @@ One of the provided features is an interface and implementation of a publish wor
with an accompanying interface that models can implement that want to support this checker.
Furthermore it provides a twig helper exposing several useful functions for twig templates
-to interact with PHPCR-ODM documents
+to interact with PHPCR-ODM documents.
.. index:: CoreBundle, PHPCR, ODM, publish workflow
@@ -148,7 +148,7 @@ RDBMS shipped with PHP itself. At the other end of the spectrum Jackalope also s
`Jackrabbit <http://jackrabbit.apache.org>`_ which supports clustering and can efficiently
handle data into the hundreds of gigabytes. By default Jackrabbit simply uses the file system for
persistence, but it can also use an RDBMS. However future versions will support MongoDB and support for
-other NoSQL solutions like CouchDB or Cassandra are entirely possible. Again switching the persistence
+other NoSQL solutions like CouchDB or Cassandra is entirely possible. Again, switching the persistence
solution would require no code changes as the business logic is only bound to the PHPCR interfaces.
Please see :doc:`installing-configuring-doctrine-phpcr-odm` for more details on the all available
@@ -157,10 +157,10 @@ PHPCR implementations and their requirements and how to setup the Symfony2 with
PHPCR ODM
~~~~~~~~~
-As mentioned above using PHPCR does not mean giving up on RDBMS. In many ways PHPCR can be considered
+As mentioned above using PHPCR does not mean giving up on RDBMS. In many ways, PHPCR can be considered
a specialized ORM solution for CMS. However while PHPCR works with so called *nodes*, in an ORM
people expect to be able to map class instances to a persistence layer. This is exactly what PHPCR ODM
provides. It follows the same interface classes as Doctrine ORM while also exposing all the additional
-capabilities of PHPCR, like trees and versioning. Furthermore it also provides native support for
+capabilities of PHPCR, like trees and versioning. Furthermore, it also provides native support for
translations, covering the only omission of PHPCR for the above mentioned requirements list of a CMS
storage solution.
@@ -80,7 +80,7 @@ can be found in the dedicated documentation.
Configuration
-------------
-To get your application running very little configuration is needed.
+To get your application running, very little configuration is needed.
Minimum configuration
~~~~~~~~~~~~~~~~~~~~~
@@ -35,7 +35,7 @@ an API that is optimized for the needs of a CMS (tree structures, references, ve
text search etc.). While every content repository can have very different requirements and
performance characteristics, the API is the same for all of them.
-Furthermore since the API defines an export/import format, you can always switch to a different
+Furthermore, since the API defines an export/import format, you can always switch to a different
content repository implementation later on.
These are the available choices:
@@ -62,7 +62,7 @@ Configuration
-------------
Next step is to configure the bundles.
-Basic configuration, add to your application configuration
+Basic configuration, add to your application configuration:
.. configuration-block::

0 comments on commit 9e6c7f3

Please sign in to comment.