update menu bundle documentation for cmf 2.0 #822
Conversation
dbu
force-pushed
the
menu-doc-update
branch
3 times, most recently
from
3328411 to
4135c1d
Compare
bundles/menu/configuration.rst
Outdated
| content documents can be found. This is used by the admin class to pre-select | ||
| the content branch of the document hierarchy in forms. | ||
| content documents can be found. This is used by the sonata admin integration to | ||
| know what tree to show when selecting content for menu nodes. |
bundles/menu/introduction.rst
Outdated
| A menu created using the KnpMenuBundle is made up of a hierarchy of class | ||
| instances implementing ``NodeInterface``. This is also true of a menu created | ||
| using MenuBundle documents. | ||
| For the Knp menu, a menu is made up of a hierarchy of objects implementing |
There was a problem hiding this comment.
Probably Knp Menu (it's a title)
There was a problem hiding this comment.
If this is the first mention in this section, maybe a hyperlink Knp Menu
bundles/menu/introduction.rst
Outdated
| Sometimes, the menu is not located within the ``persistence.phpcr.menu_basepath``. | ||
| In this case, you can use an absolute path (starting with a forward slash) to render | ||
| the menu: | ||
| To render a menu that is not located underneath the ``menu_basepath``, you |
There was a problem hiding this comment.
Think I prefer within here, or maybe using tree terminology a menu that is not a descendant of the
There was a problem hiding this comment.
going with "child of", that seems the clearest. because the menu name has to be a direct child of the basepath
bundles/menu/introduction.rst
Outdated
| the menu: | ||
| To render a menu that is not located underneath the ``menu_basepath``, you | ||
| can use an absolute path (starting with a forward slash) to render that | ||
| menu: |
There was a problem hiding this comment.
to render that menu is redundant I think?
bundles/menu/menu_factory.rst
Outdated
| to render a menu. A menu factory creates such *menu items* from the *menu | ||
| nodes* provided by the menu provider. | ||
| The menu node documents are only used for persisting the menu data, they are | ||
| not actually used when rendering a menu. The Knp menu rendering engine needs |
| @@ -5,19 +5,20 @@ Menu Provider | |||
| ============= | |||
|
|
|||
| A menu provider is responsible for loading a menu when it is requested. KnpMenu | |||
There was a problem hiding this comment.
i use KnpMenu everywhere now to be consistent. that is the name they use themselves
| Install the IvoryCKEditorBundle_ to enable a CKEditor to edit the content | ||
| body: | ||
| The content admin comes with an optional integration for the CKEditor WYSIWYG | ||
| editor. To use the editor, install the IvoryCKEditorBundle_: |
There was a problem hiding this comment.
Hmm, too many "editor" references, maybe just CK WYSIWYG Editor
| content page. | ||
|
|
||
| The menu admin uses the ``cmf_menu.persistence.phpcr.menu_basepath`` setting to | ||
| know where to add menus. The menu node admin additionally uses |
| The menu admin uses the ``cmf_menu.persistence.phpcr.menu_basepath`` setting to | ||
| know where to add menus. The menu node admin additionally uses | ||
| ``cmf_menu.persistence.phpcr.content_basepath`` to show the tree to select | ||
| content for a menu node. |
There was a problem hiding this comment.
tree to select => tree used to select ?
|
thanks for the detailed review dan! i changed all points, mostly taking your suggestions. |
fixes part of #786 and #787