TASK: "NodeTree Presets" documentation (#2128)

adds some basic documentation for the "NodeTree Presets" feature introduced with neos/neos-ui#2048 Related: #1952
neos · Aug 1, 2018 · d3eadbc · d3eadbc
1 parent 6c69929
commit d3eadbc
Showing 1 changed file with 32 additions and 7 deletions.
diff --git a/Documentation/References/Configuration/Configuration.rst b/Documentation/References/Configuration/Configuration.rst
@@ -23,10 +23,13 @@ If you have lots of nodes you can reduce the number of levels inside ``Settings.
           structureTree:
             loadingDepth: 2
 
-Node tree base node type
-~~~~~~~~~~~~~~~~~~~~~~~~
+Node tree presets
+~~~~~~~~~~~~~~~~~
 
-Allows configuring the baseNodeType used in the node tree.
+By default all node types that extend ``Neos.Neos:Document`` appear in the ``Node tree filter``
+allowing the editor to only show nodes of the selected type in the tree.
+
+The default ``baseNodeType`` can be changed in order to hide nodes from the tree by default.
 
 This example shows how to exclude one specific node type (and it's children) from the tree:
 
@@ -38,9 +41,31 @@ This example shows how to exclude one specific node type (and it's children) fro
         navigateComponent:
           nodeTree:
             presets:
-              default:
+              'default':
                 baseNodeType: 'Neos.Neos:Document,!Acme.Com:SomeNodeTypeToIgnore'
 
-.. note::
-  The naming of the configuration (``presets``) keeps into account that the node tree should support multiple presets
-  in the future.
+In addition to the ``default`` preset, additional presets can be configured such as:
+
+.. code-block:: yaml
+
+  Neos:
+    Neos:
+      userInterface:
+        navigateComponent:
+          nodeTree:
+            presets:
+              'default':
+                baseNodeType: 'Neos.Neos:Document,!Acme.Com:Mixin.HideInBackendByDefault'
+              'legalPages':
+                ui:
+                  label: 'Legal pages'
+                  icon: 'icon-gavel'
+                baseNodeType: 'Acme.Com:Document.Imprint,Acme.Com:Document.Terms'
+              'landingPages':
+                ui:
+                  label: 'Landing pages'
+                  icon: 'icon-bullseye'
+                baseNodeType: 'Acme.Com:Mixin.LandingPage'
+
+If at least one custom preset is defined, instead of the list of all node types the filter will
+display the configured presets.