[izpack-changes] r1992 - izpack-src/trunk/src/doc-reST

[noreply at berlios.de]

Author: jponge
Date: 2008-01-20 16:56:44 +0100 (Sun, 20 Jan 2008)
New Revision: 1992

Modified:
   izpack-src/trunk/src/doc-reST/panels.txt
Log:
TreePacksPanel documented by Piotr Skowronek


Modified: izpack-src/trunk/src/doc-reST/panels.txt
===================================================================
--- izpack-src/trunk/src/doc-reST/panels.txt	2008-01-20 15:48:55 UTC (rev 1991)
+++ izpack-src/trunk/src/doc-reST/panels.txt	2008-01-20 15:56:44 UTC (rev 1992)
@@ -80,7 +80,9 @@
 PacksPanel
 ----------
 
-Allows the user to select the packs he wants to install.
+Allows the user to select the packs he wants to install. This
+panel also allows grouping of packs. Look at ``InstallationGroupPanel``
+description to get more details.
 
 
 
@@ -103,6 +105,51 @@
 
 
 
+TreePacksPanel
+--------------
+
+This panel is very similar to ``PacksPanel``, but instead of simple list
+of available packs, the tree-like list is constructed. By using the ``parent``
+attribute of ``pack`` element, one can specify the hierarchy of the tree.
+This panel supports grouping just like ``PacksPanel`` does.
+
+example ::
+
+        <installation version="1.0">
+           (...)
+            <panels>
+                (...)
+                <panel classname="TreePacksPanel"/>
+                (...)
+            </panels>
+
+            <packs>
+                <pack name="Base"
+                    required="yes">
+                    (...)
+                </pack>
+                <pack name="Themes"
+                    required="no">
+                    (...)
+                </pack>
+                <pack name="Black"
+                    parent="Themes"
+                    required="no">
+                    (...)
+                </pack>
+                <pack name="Red"
+                    parent="Themes"
+                    required="no">
+                    (...)
+                </pack>
+            </packs>
+        </installation>
+
+The result tree contains Base element with no children,
+and Themes with two children named Black and Red.
+
+
+
 TargetPanel
 ------------