Permalink
Browse files

lots of typo fixes and minor corrects

  • Loading branch information...
1 parent 6cc8bd9 commit 064b4ff2040b90758d5fac1738dc1cfa91bb4f95 @lsmith77 lsmith77 committed Jan 24, 2013
View
@@ -242,9 +242,9 @@ Alternative: Aloha Editor
Optional: Aloha Editor (create.js ships with the hallo editor, but if you prefer you can also use aloha)
- To use the Aloha editor, download the files here: https://github.com/alohaeditor/Aloha-Editor/downloads/
- Unzip the contents of the "aloha" subfolder in the zip file as folder vendor/symfony-cmf/create-bundle/Symfony/Cmf/Bundle/CreateBundle/vendor/aloha
- Make sure you have just one aloha folder with the js, not aloha/aloha/... - you should have vendor/symfony-cmf/create-bundle/Symfony/Cmf/Bundle/CreateBundle/vendor/aloha/aloha.js
+ To use the Aloha editor, download the files here: https://github.com/alohaeditor/Aloha-Editor/downloads/
+ Unzip the contents of the "aloha" subfolder in the zip file as folder vendor/symfony-cmf/create-bundle/Symfony/Cmf/Bundle/CreateBundle/vendor/aloha
+ Make sure you have just one aloha folder with the js, not aloha/aloha/... - you should have vendor/symfony-cmf/create-bundle/Symfony/Cmf/Bundle/CreateBundle/vendor/aloha/aloha.js
Usage
View
@@ -60,14 +60,14 @@ if Sonata becomes unavailable.
Menu entries
------------
-Document\MenuItem defines menu entries. You can build menu items based on
+``MenuItem`` document defines menu entries. You can build menu items based on
symfony routes, absolute or relative urls or referenceable PHPCR-ODM content
documents.
The menu tree is built from documents under [menu_basepath]/[menuname]. You can
use different document classes for menu items, as long as they implement
-``Knp\Menu\NodeInterface`` to integrate with KnpMenuBundle. The default MenuItem
-Document discards children that do not implement this interface.
+``Knp\Menu\NodeInterface`` to integrate with KnpMenuBundle. The default ``MenuNode``
+document discards children that do not implement this interface.
The currently highlighted entry is determined by checking if the content
associated with a menu document is the same as the content the DynamicRouter
@@ -100,7 +100,7 @@ make sure that the menu root document is found with
$dm->find($menu_document_class, $menu_basepath . $menu_name)
The route document must implement ``Knp\Menu\NodeInterface`` - see
-Document/MenuItem.php for an example. You probably need to specify
+``MenuNode`` document for an example. You probably need to specify
menu_document_class too, as only PHPCR-ODM can determine the document from the
database content.
View
@@ -37,7 +37,7 @@ PHPCR Session Configuration
The session needs a PHPCR implementation specified in the ``backend`` section
by the ``type`` field, along with configuration options to bootstrap the
-implementation. Currently we support jackrabbit, doctrinedbal and midgard2.
+implementation. Currently we support ``jackrabbit``, ``doctrinedbal`` and ``midgard2``.
Regardless of the backend, every PHPCR session needs a workspace, username and
password.
@@ -456,7 +456,7 @@ Use ``app/console help <command>`` to see all options each of the commands has.
- ``doctrine:phpcr:workspace:create`` Create a workspace in the configured repository
- ``doctrine:phpcr:workspace:list`` List all available workspaces in the configured repository
-- ``doctrine:phpcr:purge`` Remove all content from the repository
+- ``doctrine:phpcr:purge`` Remove content from the repository
- ``doctrine:phpcr:register-system-node-types`` Register system node types in the PHPCR repository
- ``doctrine:phpcr:register-node-types`` Register node types in the PHPCR repository
- ``doctrine:phpcr:fixtures:load`` Load data fixtures to your PHPCR database.
View
@@ -110,7 +110,7 @@ following section on more details for the default `PHPCR-ODM`_ based
implementation.
You may want to configure route enhancers to decide what controller is used to
-handle the request, to avoid hardcoding controller names into your route
+handle the request, to avoid hard coding controller names into your route
documents.
The minimum configuration required to load the dynamic router as service
@@ -175,12 +175,12 @@ The possible enhancements are (in order of precedence):
* Controller by alias: requires the route document to return a 'type' value in
getRouteDefaults()
* Controller by class: requires the route document to return an object for
- getRouteContent(). The content document is checked for being instanceof the
+ getRouteContent(). The content document is checked for being ``instanceof`` the
class names in the map and if matched that controller is used.
Instanceof is used instead of direct comparison to work with proxy classes
and other extending classes.
* Template by class: requires the route document to return an object for
- getRouteContent(). The content document is checked for being instanceof the
+ getRouteContent(). The content document is checked for being ``instanceof`` the
class names in the map and if matched that template will be set as
'_template' in the $defaults and the generic controller used as controller.
@@ -193,7 +193,7 @@ The possible enhancements are (in order of precedence):
symfony_cmf_routing_extra:
dynamic:
generic_controller: symfony_cmf_content.controller:indexAction
- controllers_by_alias:
+ controllers_by_type:
editablestatic: sandbox_main.controller:indexAction
controllers_by_class:
Symfony\Cmf\Bundle\ContentBundle\Document\StaticContent: symfony_cmf_content.controller::indexAction
@@ -352,11 +352,7 @@ Notes:
* RouteObjectInterface: The provided documents implement this interface to map content to routes and to (optional) provide
a custom route name instead of the symfony core compatible route name.
-* Redirections: This bundle provides a RedirectController.
-
-TODO: see DependencyInjection/Configuration.php of this bundle. I could not figure out how to set
-this mapping as a default mapping. Meanwhile, in order to do redirections, you
-need to add an entry to your mapping in the project configuration
+* Redirections: This bundle provides a controller to handle redirections.
.. configuration-block::
View
@@ -2,7 +2,8 @@ SearchBundle
============
The `SearchBundle <https://github.com/symfony-cmf/SearchBundle#readme>`_
-provides integration with LiipSearchBundle to handle a site wide search.
+provides integration with `LiipSearchBundle <https://github.com/liip/LiipSearchBundle>`_
+to provide a site wide search.
.. index:: SearchBundle
View
@@ -129,7 +129,7 @@ In this example, we will have the menu elements :
.. code-block:: jinja
- {% render 'sonata.admin.doctrine_phpcr.tree_controller:treeAction' with { 'root': websiteId~"/menu", 'selected': menuItemId } %}
+ {% render 'sonata.admin.doctrine_phpcr.tree_controller:treeAction' with { 'root': websiteId~"/menu", 'selected': menuNodeId } %}
How to customize the tree behaviour
@@ -147,7 +147,7 @@ Here is a simple way to remove the context menu from the admin tree :
.. code-block:: jinja
- {% render 'sonata.admin.doctrine_phpcr.tree_controller:treeAction' with { 'root': websiteId~"/menu", 'selected': menuItemId } %}
+ {% render 'sonata.admin.doctrine_phpcr.tree_controller:treeAction' with { 'root': websiteId~"/menu", 'selected': menuNodeId } %}
<script type="text/javascript">
$(document).ready(function() {
$('#tree').bind("before.jstree", function (e, data) {
@@ -185,7 +185,7 @@ For example, if your want to open a custom action :
$('#tree').bind("select_node.jstree", function (event, data) {
if ((data.rslt.obj.attr("rel") == 'Symfony_Cmf_Bundle_MenuBundle_Document_MenuNode'
|| data.rslt.obj.attr("rel") == 'Symfony_Cmf_Bundle_MenuBundle_Document_MultilangMenuNode')
- && data.rslt.obj.attr("id") != '{{ menuItemId }}'
+ && data.rslt.obj.attr("id") != '{{ menuNodeId }}'
) {
var routing_defaults = {'locale': '{{ locale }}', '_locale': '{{ _locale }}'};
routing_defaults["id"] = data.rslt.obj.attr("url_safe_id");
View
@@ -41,7 +41,7 @@ Dependencies
This component uses `composer <http://getcomposer.org>`_. It needs the
Symfony2 Routing component and the Symfony2 HttpKernel (for the logger
-interface and cache warmup interface).
+interface and cache warm-up interface).
For the ``DynamicRouter`` you will need something to implement the
``RouteProviderInterface`` with. We suggest using Doctrine as this provides an
@@ -70,9 +70,10 @@ Routers
The ``ChainRouter`` is incapable of, by itself, making any actual routing decisions.
It's sole responsibility is managing the given set of Routers, which are the
-true responsibles for matching a request and determining its parameters.
+true responsible for matching a request and determining its parameters.
-You can easily create your own Routers by implementing `RouterInterface <http://api.symfony.com/2.1/Symfony/Component/Routing/RouterInterface.html>`_
+You can easily create your own Routers by implementing
+`RouterInterface <http://api.symfony.com/master/Symfony/Component/Routing/RouterInterface.html>`_
but Symfony CMF already includes a powerful route matching system that you can
extend to your needs.
@@ -127,7 +128,7 @@ It uses a ``RouteProviderInterface`` implementation, which is capable of
loading candidate `Route <http://api.symfony.com/master/Symfony/Component/Routing/Route.html>`_
objects for a Request dynamically from a data source. Although it can be used
in other ways, the ``RouteProviderInterface``'s main goal is to be easily
-implementented on top of Doctrine PHPCR ODM or a relational database,
+implemented on top of Doctrine PHPCR ODM or a relational database,
effectively allowing you to store and manage routes dynamically from database.
The ``NestedMatcher`` uses a 3-step matching process to determine which Route
@@ -171,7 +172,7 @@ of the Symfony Routing Component.
Route Enhancers
^^^^^^^^^^^^^^^
-Optionally, and following the matching proccess, a set of ``RouteEnhancerInterface``
+Optionally, and following the matching process, a set of ``RouteEnhancerInterface``
instances can be applied by the ``DynamicRouter``. The aim of these is to allow you to
manipulate the parameters from the matched route. They can be used, for
example, to dynamically assign a controller or template to a ``Route`` or to
@@ -226,7 +227,8 @@ match a Request/URL to its corresponding parameters, the ``DynamicRouter``
also uses an ``UrlGeneratorInterface`` instance, which allows it to
generate an URL from a Route.
-The included ``ProviderBasedGenerator`` extends Symfony2's default `UrlGenerator <http://api.symfony.com/2.1/Symfony/Component/Routing/Generator/UrlGenerator.html>`_
+The included ``ProviderBasedGenerator`` extends Symfony2's default
+`UrlGenerator <http://api.symfony.com/master/Symfony/Component/Routing/Generator/UrlGenerator.html>`_
(which, in turn, implements ``UrlGeneratorInterface``) and - if $name is
not already a ``Route`` object - loads the route from the ``RouteProviderInterface``.
It then lets the core logic generate the URL from that Route.
@@ -290,7 +292,8 @@ a look at :doc:`../bundles/routing-extra`.
For a starter's guide to the Routing bundle and its integration with Symfony2,
refer to :doc:`../getting-started/routing`
-We strongly recommend reading Symfony2's `Routing <http://symfony.com/doc/current/components/routing/introduction.html>`__
+We strongly recommend reading Symfony2's
+`Routing <http://symfony.com/doc/current/components/routing/introduction.html>`__
component documentation page, as it's the base of this bundle's implementation.
Authors
@@ -99,8 +99,8 @@ Next, get composer and install and the necessary bundles (this may take a while)
Preparing the PHPCR repository
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Now that you have all the code, you need to setup your PHPRC repository.
-PHPRC organizes data in workspaces, and sandbox uses the "default" workspace,
+Now that you have all the code, you need to setup your PHPCR repository.
+PHPCR organizes data in workspaces, and sandbox uses the "default" workspace,
which is exists by default in Jackrabbit. If you use other applications that
require Jackrabbit, or if you just wish to change the workspace name, you
can do so in app/config/phpcr.yml. The following command will create
@@ -265,7 +265,7 @@ You also need to download `midgard_tree_node.xml <https://raw.github.com/midgard
and `midgard_namespace_registry.xml <https://github.com/midgardproject/phpcr-midgard2/raw/master/data/share/schema/midgard_namespace_registry.xml>`_
schema files, and place them into "<your-midgard2-folder>/schema" (defaults to "/usr/share/midgard2/schema")
-To have the midgard phpcr implementation installed run the following additional command:
+To have the Midgard2 PHPCR implementation installed run the following additional command:
.. code-block:: bash
@@ -36,7 +36,7 @@ Multilang Static Content
------------------------
The ``MultilangStaticContent`` extends ``StaticContent``, offering the same
-functionality with multilanguage support. It specifies which fields are to
+functionality with multi language support. It specifies which fields are to
be translated (``title``, ``body`` and ``tags``) as well as a variable to
declare the locale.
@@ -58,9 +58,9 @@ Content Controller
------------------
To handle both content types, a ``Controller`` is also included. Its inner
-workings are pretty straighforward: it accepts a content instance and optionally
-a template to render it. If none is provided, it uses a preconfigured default.
-It also takes into account the document's publishing status and multilanguage.
+workings are pretty straightforward: it accepts a content instance and optionally
+a template to render it. If none is provided, it uses a pre-configured default.
+It also takes into account the document's publishing status and multi language.
Both the content instance and the optional template are provided to the Controller
by the ``DynamicRouter`` of the ``RoutingExtraBundle``. More information on this is
available on the :ref:`Routing system getting started page <routing-linking-a-route-with-a-model-instance>`
@@ -71,7 +71,7 @@ Admin support
The last component needed to handle the included content types is an administration
panel. Symfony CMF can optionally support `SonataDoctrinePHPCRAdminBundle <https://github.com/sonata-project/SonataDoctrinePhpcrAdminBundle>`_
-, a backoffice generation tool. For more information about it, please refer
+, a back office generation tool. For more information about it, please refer
to the bundle's `documentation section <https://github.com/sonata-project/SonataDoctrinePhpcrAdminBundle/tree/master/Resources/doc>`_.
In ``ContentBundle``, the required administration panels are already declared
@@ -92,5 +92,5 @@ Final thoughts
While this small bundle includes some vital components to a fully working
CMS, it often will not provide all you need. The main idea behind it is to
provide developers with a small and easy to understand starting point you can
-extend or use as inspriation to develop your own content types, Controllers and
+extend or use as inspiration to develop your own content types, Controllers and
Admin panels.
@@ -150,5 +150,5 @@ into a browsable website. The overall, simplified process is:
- As configured, the retrieved content is passed to ContentBundle's ContentController, which will handle it and render AcmeMainBundle's layout.html.twig.
Again, this is simplified view of a very simple CMS built on top of Symfony CMF.
- To fully understand all the possibilities of the CMF, a carefull look into
+ To fully understand all the possibilities of the CMF, a careful look into
each component is needed.
Oops, something went wrong.

0 comments on commit 064b4ff

Please sign in to comment.