-
Notifications
You must be signed in to change notification settings - Fork 157
[WIP] TreeBrowser 2.0 docs #815
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
great job so far! i only commented a few things, and made comments in the 2 places where the doc needs to be written, just to make sure we don't miss that later.
<?xml version="2.0" encoding="UTF-8"?> | ||
<container xmlns="http://symfony.com/dic/schema/services" | ||
xmlns:xsd="http://www.w3.org/2001/XMLSchema-instance" | ||
xsd:schemaLocation="http://symfony.com/dic/schema/services http://symfony.com/dic/schema/services/services-1.0.xsd |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we not rename this xsd file to 2.0 or remove the version if we completely change the configuration format?
@@ -5,4 +5,7 @@ TreeBrowserBundle | |||
:maxdepth: 2 | |||
|
|||
introduction | |||
forms | |||
tree |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we find a better filename for this? all chapters are somehow about trees - is this one about rendering? about the js side?
Displaying Nodes inside the Tree | ||
================================ | ||
|
||
The TreeBrowserBundle provides a ``cmfTree`` jQuery plugin. This plugin is an |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you used CmfTreeBrowserBundle above, when talking about registering. can we consistently use the Cmf prefix? as the bundle registration is with the FQN anyways, i think it would be ok to omit the Cmf prefix above.
|
||
Using this code, a tree will be shown in the ``<div>`` tag. The | ||
``/api/default/`` URI will be used to request for nodes. Note that this | ||
happends lazily, so after opening a node with no children loaded yet, the URL |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/happends/happens/
will again be requested for the children (e.g. ``/api/default/cms/content`` | ||
when opening the ``/cms/content`` node). | ||
|
||
Options |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO: write out the options doc
.. index:: | ||
single: Forms; TreeBrowserBundle | ||
|
||
How to Use the Tree as a Form Type |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO document the form type
No description provided.