Skip to content
This repository was archived by the owner on Sep 16, 2021. It is now read-only.

Commit 03940b5

Browse files
committed
move sonata reference documentation to sonata
1 parent 9e12c18 commit 03940b5

File tree

14 files changed

+82
-242
lines changed

14 files changed

+82
-242
lines changed

book/static_content.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,7 @@ Admin Support
7676

7777
The last component needed to handle the included content types is an
7878
administration panel. Symfony CMF can optionally support
79-
`SonataDoctrinePHPCRAdminBundle`_, a back office generation tool. For more
80-
information about it, please refer to the bundle's `documentation section`_.
79+
SonataDoctrinePHPCRAdminBundle_, a back office generation tool.
8180

8281
In ContentBundle, the required administration panels are already declared in
8382
the ``Admin`` folder and configured in ``Resources/config/admin.xml``, and
@@ -101,5 +100,4 @@ or use as inspiration to develop your own content types, Controllers and Admin
101100
panels.
102101

103102
.. _`multilanguage support in PHPCR-ODM`: http://docs.doctrine-project.org/projects/doctrine-phpcr-odm/en/latest/reference/multilang.html
104-
.. _`SonataDoctrinePHPCRAdminBundle`: https://github.com/sonata-project/SonataDoctrinePhpcrAdminBundle
105-
.. _`documentation section`: https://github.com/sonata-project/SonataDoctrinePhpcrAdminBundle/tree/master/Resources/doc
103+
.. _SonataDoctrinePHPCRAdminBundle: https://github.com/sonata-project/SonataDoctrinePhpcrAdminBundle

book/structuring_content.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ Symfony CMF Menu System
2121
~~~~~~~~~~~~~~~~~~~~~~~
2222

2323
Symfony CMF SE includes the MenuBundle, a tool that allow you to dynamically
24-
define your menus. It extends the `KnpMenuBundle`_, with a set of
24+
define your menus. It extends the KnpMenuBundle_, with a set of
2525
hierarchical, multi language menu elements, along with the tools to persist
2626
them in the chosen content store. It also includes the administration panel
2727
definitions and related services needed for integration with the
28-
`SonataDoctrinePhpcrAdminBundle`_.
28+
SonataDoctrinePHPCRAdminBundle_.
2929

3030
.. note::
3131

32-
The MenuBundle extends and greatly relies on the `KnpMenuBundle`_, so you
32+
The MenuBundle extends and greatly relies on the KnpMenuBundle_, so you
3333
should carefully read `KnpMenuBundle's documentation`_. For the rest of
3434
this page we assume you have done so and are familiar with concepts like
3535
Menu Providers and Menu Factories.
@@ -114,7 +114,7 @@ The included implementation focuses on generating ``MenuItem`` instances from
114114
``NodeInterface`` instances, as this is usually the best approach to handle
115115
tree-like structures typically used by a CMS. Other approaches are implemented in
116116
the base classes, and their respective documentation pages can be found in
117-
`KnpMenuBundle`_'s page.
117+
KnpMenuBundle_'s page.
118118

119119
``ContentAwareFactory`` is responsible for loading the full menu hierarchy and
120120
transforming the ``MenuNode`` instances from the root node it receives from
@@ -179,12 +179,12 @@ Admin Support
179179

180180
The MenuBundle also includes the administration panels and respective services
181181
needed for integration with the backend admin tool
182-
:doc:`SonataDoctrinePhpcrAdminBundle <../bundles/doctrine_phpcr_admin>`
182+
SonataDoctrinePHPCRAdminBundle_.
183183

184184
The included administration panels are automatically available but need to
185185
be explicitly put on the dashboard if you want to use them. See
186186
:doc:`../cookbook/creating_cms_using_cmf_and_sonata` for instructions on how
187-
to install SonataDoctrinePhpcrAdminBundle.
187+
to install SonataDoctrinePHPCRAdminBundle.
188188

189189
Configuration
190190
~~~~~~~~~~~~~
@@ -193,10 +193,10 @@ This bundle is configurable using a set of parameters, but all of them are
193193
optional. You can go to the :doc:`../bundles/menu/index` reference page for the full
194194
configuration options list and additional information.
195195

196-
.. _`KnpMenuBundle`: https://github.com/knplabs/KnpMenuBundle
197-
.. _`SonataDoctrinePhpcrAdminBundle`: https://github.com/sonata-project/SonataDoctrinePhpcrAdminBundle
196+
.. _KnpMenuBundle: https://github.com/knplabs/KnpMenuBundle
198197
.. _`KnpMenuBundle's documentation`: https://github.com/KnpLabs/KnpMenuBundle/blob/master/Resources/doc/index.md
199198
.. _`respective documentation page`: https://github.com/KnpLabs/KnpMenuBundle/blob/master/Resources/doc/index.md#rendering-menus
200199
.. _`Doctrine PHPCR documentation page`: http://docs.doctrine-project.org/projects/doctrine-phpcr-odm/en/latest/reference/association-mapping.html#references
201200
.. _`Multi language support in PHPCR-ODM`: http://docs.doctrine-project.org/projects/doctrine-phpcr-odm/en/latest/reference/multilang.html
202201
.. _`KnpMenu`: https://github.com/knplabs/KnpMenu
202+
.. _SonataDoctrinePHPCRAdminBundle: http://sonata-project.org/bundles/doctrine-phpcr-admin/master/doc/index.html

bundles/block/types.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ Sonata Admin
2929
~~~~~~~~~~~~
3030

3131
All block types provided by the Symfony2 CMF BlockBundle come with a admin
32-
classes for :doc:`../doctrine_phpcr_admin`. To activate the admin services,
33-
it is enough to load the SonataDoctrinePhpcrAdminBundle in your application
32+
classes for SonataDoctrinePHPCRAdminBundle_. To activate the admin services,
33+
it is enough to load the SonataDoctrinePHPCRAdminBundle in your application
3434
kernel and configure the sonata dashboard as desired.
3535

3636
.. _bundles-block-types-admin_extension:
@@ -410,3 +410,4 @@ for further information.
410410
.. _`LiipImagineBundle`: https://github.com/liip/LiipImagineBundle
411411
.. _`LiipImagineBundle documentation`: https://github.com/liip/LiipImagineBundle/tree/master/Resources/doc
412412
.. _`sub-request`: http://symfony.com/doc/current/book/internals.html#internal-requests
413+
.. _SonataDoctrinePHPCRAdminBundle: http://sonata-project.org/bundles/doctrine-phpcr-admin/master/doc/index.html

bundles/doctrine_phpcr_admin.rst

Lines changed: 0 additions & 52 deletions
This file was deleted.

bundles/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ Bundles
1616
routing/index
1717
search/index
1818
simple_cms/index
19-
doctrine_phpcr_admin
2019
tree_browser/index
2120

2221
.. include:: map.rst.inc

bundles/map.rst.inc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,6 @@ help with integrating PHPCR concepts into the Symfony Framework.
9595

9696
* :doc:`phpcr_odm`
9797

98-
* **SonataDoctrinePhpcrAdminBundle**
98+
* SonataDoctrinePHPCRAdminBundle_
9999

100-
* :doc:`doctrine_phpcr_admin`
100+
.. _SonataDoctrinePHPCRAdminBundle: http://sonata-project.org/bundles/doctrine-phpcr-admin/master/doc/index.html

bundles/menu/sonata_admin.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,13 @@
44
Menu Admin with Sonata PHPCR-ODM
55
================================
66

7-
If the :doc:`SonataDoctrinePhpcrAdminBundle <../doctrine_phpcr_admin>` is
8-
loaded in the application kernel, menu node and menu documents can be
9-
administrated in Sonata admin. For instructions on how to configure Sonata,
10-
see :doc:`../doctrine_phpcr_admin`.
7+
If the SonataDoctrinePHPCRAdminBundle_ is loaded in the application kernel,
8+
menu node and menu documents can be administrated in Sonata admin. For
9+
instructions on how to configure Sonata, see `configuring sonata admin`_.
1110

1211
Loading of Sonata is controlled with the ``use_sonata_admin`` configuration
1312
setting. By default, this option is automatically set based on whether
14-
SonataDoctrinePhpcrAdminBundle is available, but you can explicitly
13+
SonataDoctrinePHPCRAdminBundle is available, but you can explicitly
1514
disable the flag to not provide the Sonata services even if Sonata would be
1615
available. You can also explicitly enable the flag to get an error if Sonata
1716
becomes unavailable.
@@ -128,3 +127,5 @@ configuration in the ``sonata_admin`` section of your project configuration:
128127
See the `Sonata Admin extension documentation`_ for more information.
129128

130129
.. _`Sonata Admin extension documentation`: http://sonata-project.org/bundles/admin/master/doc/reference/extensions.html
130+
.. _SonataDoctrinePHPCRAdminBundle: http://sonata-project.org/bundles/doctrine-phpcr-admin/master/doc/index.html
131+
.. _`configuring sonata admin`: http://sonata-project.org/bundles/doctrine-phpcr-admin/master/doc/reference/configuration.html

bundles/phpcr_odm.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -580,7 +580,7 @@ to a list of allowed managed documents. Please refer to the
580580
`Symfony documentation on the entity form type`_ for more details,
581581
including how you can configure a query.
582582

583-
If you are using Sonata Admin, you might want to look into
583+
If you are using SonataDoctrinePHPCRAdminBundle_, you might want to look into
584584
``sonata_type_collection``. This form type allows to edit related
585585
documents (references as well as children) inline and also to create
586586
and remove them on the fly.
@@ -618,10 +618,10 @@ The minimal code required to use this type looks as follows::
618618

619619
.. tip::
620620

621-
When building an admin interface with
622-
:doc:`Sonata Admin <doctrine_phpcr_admin>` there is also the
623-
``sonata_type_model`` that is more powerful, allowing to add to the
624-
referenced documents on the fly. Unfortunately it is `currently broken`_.
621+
When building an admin interface with the SonataDoctrinePHPCRAdminBundle_
622+
there is also the ``sonata_type_model`` that is more powerful, allowing to
623+
add to the referenced documents on the fly. Unfortunately it is
624+
`currently broken`_.
625625

626626
phpcr_reference
627627
~~~~~~~~~~~~~~~
@@ -868,6 +868,7 @@ Dumping nodes under ``/cms/simple`` including their properties:
868868
.. _`Symfony event subscriber`: http://symfony.com/doc/master/components/event_dispatcher/introduction.html#using-event-subscribers
869869
.. _`Symfony cookbook entry`: http://symfony.com/doc/current/cookbook/doctrine/event_listeners_subscribers.html
870870
.. _`Symfony documentation on the entity form type`: http://symfony.com/doc/current/reference/forms/types/entity.html
871+
.. _SonataDoctrinePHPCRAdminBundle: http://sonata-project.org/bundles/doctrine-phpcr-admin/master/doc/index.html
871872
.. _`currently broken`: https://github.com/sonata-project/SonataDoctrineORMAdminBundle/issues/145
872873
.. _`DoctrineMigrationsBundle`: http://symfony.com/doc/current/bundles/DoctrineMigrationsBundle/index.html
873874
.. _`DoctrineFixturesBundle`: http://symfony.com/doc/current/bundles/DoctrineFixturesBundle/index.html

bundles/routing/dynamic.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -276,13 +276,12 @@ need content, you can just not set it in the route document.
276276
Sonata Doctrine PHPCR-ODM Admin classes
277277
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
278278

279-
If the :doc:`SonataDoctrinePhpcrAdminBundle <../doctrine_phpcr_admin>` is
280-
loaded in the application kernel, route and redirect route documents can be
281-
administrated in sonata admin. For instructions on how to configure Sonata,
282-
see :doc:`../doctrine_phpcr_admin`.
279+
If the SonataDoctrinePHPCRAdminBundle_ is loaded in the application kernel,
280+
route and redirect route documents can be administrated in sonata admin. For
281+
instructions on how to configure Sonata, see `configuring sonata admin`_.
283282

284283
By default, ``use_sonata_admin`` is automatically set based on whether
285-
SonataDoctrinePhpcrAdminBundle is available, but you can explicitly
284+
SonataDoctrinePHPCRAdminBundle is available, but you can explicitly
286285
disable it to not have it even if sonata is enabled, or explicitly enable to
287286
get an error if Sonata becomes unavailable.
288287

@@ -569,3 +568,5 @@ Read on in the chapter :doc:`customizing the dynamic router <dynamic_customize>`
569568
.. _`PHPCR-ODM`: http://www.doctrine-project.org/projects/phpcr-odm.html
570569
.. _`Sonata Admin extension documentation`: http://sonata-project.org/bundles/admin/master/doc/reference/extensions.html
571570
.. _`URL generating capabilities of Symfony2`: http://symfony.com/doc/current/book/routing.html#generating-urls
571+
.. _SonataDoctrinePHPCRAdminBundle: http://sonata-project.org/bundles/doctrine-phpcr-admin/master/doc/index.html
572+
.. _`configuring sonata admin`: http://sonata-project.org/bundles/doctrine-phpcr-admin/master/doc/reference/configuration.html

0 commit comments

Comments
 (0)