From df30831421afdaa22e0765b5015d970c3e17e4f3 Mon Sep 17 00:00:00 2001
From: Badlop <badlop@process-one.net>
Date: Wed, 19 Aug 2009 15:44:29 +0000
Subject: Update Pubsub's nodetree documentation (thanks to Christophe Romain)

SVN Revision: 2503
---
 doc/guide.tex | 27 +++++++++++++++++++++------
 1 file changed, 21 insertions(+), 6 deletions(-)

(limited to 'doc/guide.tex')

diff --git a/doc/guide.tex b/doc/guide.tex
index 024f11b72..32081dad9 100644
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -3531,12 +3531,27 @@ Options:
   This option restricts which users are allowed to create pubsub nodes using
   ACL and ACCESS. The default value is \term{pubsub\_createnode}. % Not clear enough + do not use abbreviations.
 \titem{\{plugins, [ Plugin, ...]\}} \ind{options!plugins}
-  To specify which pubsub node plugins to use. If not defined, the default
-  pubsub plugin is always used.
-\titem{\{nodetree, Name\}} \ind{options!nodetree}
-  To specify which nodetree to use. If not defined, the default pubsub
-  nodetree is used. Only one nodetree can be used per host,
-  and is shared by all node plugins.
+  To specify which pubsub node plugins to use.
+  If not defined, the default pubsub plugin is always used: "flat".
+\titem{\{nodetree, Nodetree\}} \ind{options!nodetree}
+  To specify which nodetree to use.
+  If not defined, the default pubsub nodetree is used: "tree".
+  Only one nodetree can be used per host, and is shared by all node plugins.
+
+  The "virtual" nodetree does not store nodes on database.
+  This saves resources on systems with tons of nodes.
+  If using the "virtual" nodetree,
+  you can only enable those node plugins:
+  ["flat","pep"] or ["flat"];
+  any other plugins configuration will not work. 
+  Also, all nodes will have the defaut configuration,
+  and this can not be changed.
+  Using "virtual" nodetree requires to start from a clean database,
+  it will not work if you used the default "tree" nodetree before.
+
+  The "dag" nodetree provides experimental support for PubSub Collection Nodes (\xepref{0248}).
+  In that case you should also add "dag" node plugin as default, for example:
+  \term{\{plugins, ["dag","flat","hometree","pep"]\}}
 \titem{\{pep\_sendlast\_offline, false|true\}} \ind{options!pep\_sendlast\_offline}
   To specify whether or not we should get last published PEP items
   from users in our roster which are offline when we connect. Value is true or false.
-- 
cgit v1.2.3

