From b4e3c1338c7602e65041f4dc637aca47e1d22a01 Mon Sep 17 00:00:00 2001 From: Ingo Schommer Date: Sun, 5 Aug 2012 20:35:06 +0200 Subject: [PATCH] Improved tree docs --- docs/en/howto/customize-cms-tree.md | 5 +++++ docs/en/reference/cms-architecture.md | 12 ++++++++++++ 2 files changed, 17 insertions(+) diff --git a/docs/en/howto/customize-cms-tree.md b/docs/en/howto/customize-cms-tree.md index 8062a6eea..6ef6fad7a 100644 --- a/docs/en/howto/customize-cms-tree.md +++ b/docs/en/howto/customize-cms-tree.md @@ -2,6 +2,11 @@ ## Overview +The CMS tree for viewing hierarchical structures (mostly pages) is powered +by the [jstree](http://jstree.com) library. It is configured through +`sapphire/admin/javascript/LeftAndMain.Tree.js`, as well as some +HTML5 metadata generated on its container (see the `data-hints` attribute). + The tree is rendered through `[api:LeftAndMain->getSiteTreeFor()]`, which recursively collects all nodes based on various filtering criteria. The node strictly just has to implement the `[api:Hierarchy]` extension, diff --git a/docs/en/reference/cms-architecture.md b/docs/en/reference/cms-architecture.md index b0657cb6d..b2f29b0e4 100644 --- a/docs/en/reference/cms-architecture.md +++ b/docs/en/reference/cms-architecture.md @@ -334,6 +334,18 @@ so you don't need to worry about it. The same concept applies for 'X-Title' (change the window title) and 'X-ControllerURL' (change the URL recorded in browser history). Note: You can see any additional HTTP headers through the web developer tools in your browser of choice. +## Tree + +The CMS tree for viewing hierarchical structures (mostly pages) is powered +by the [jstree](http://jstree.com) library. It is configured through +`sapphire/admin/javascript/LeftAndMain.Tree.js`, as well as some +HTML5 metadata generated on its container (see the `data-hints` attribute). +For more information, see the [Howto: Customize the CMS tree](../howto/customize-cms-tree). + +Note that a similar tree logic is also used for the +form fields to select one or more entries from those hierarchies +(`[api:TreeDropdownField]` and `[api:TreeMultiselectField]`). + ## Related * [Howto: Extend the CMS Interface](../howto/extend-cms-interface)