<?xml version="1.0" encoding="UTF-8"?>
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="uiDumpTree">
    <refnamediv>
        <refname>uiDumpTree</refname>
        <refpurpose>Printing an uitree in the console (text mode)</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>uiDumpTree(tree[,b])
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Input parameters</title>
        <variablelist>
            <varlistentry>
                <term>tree</term>
                <listitem>
                    <para>an uitree</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>b(optional)</term>
                <listitem>
                    <para>display features of each node of the tree. By default b is '%F'.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>Display a tree into the console(text mode).</para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
// We must create leaves, nodes, branches, and the tree
node1 = uiCreateNode('Node 1');
leaf11 = uiCreateNode('leaf 1.1');
leaf12 = uiCreateNode('leaf 1.2');
treeNode1 = uiCreateTree(node1, leaf11, leaf12);

node2 = uiCreateNode('Node 2');

node3 = uiCreateNode('Node 3');
leaf31 = uiCreateNode('leaf 3.1');
leaf32 = uiCreateNode('leaf 3.2');
treeNode3 = uiCreateTree(node3, leaf31, leaf32);

root = uiCreateNode('Root');
treeRoot = uiCreateTree(root, treeNode1, node2, treeNode3);

// Display in the console:
uiDumpTree(treeRoot)
 ]]></programlisting>
    <screen><![CDATA[
--> uiDumpTree(treeRoot)
  |_./ Root
  | |_./ Node 1
  | | |_./ leaf 1.1
  | | |_./ leaf 1.2
  | |_./ Node 2
  | |_./ Node 3
  | | |_./ leaf 3.1
  | | |_./ leaf 3.2
]]></screen>
    </refsection>
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="uiDisplayTree">uiDisplayTree</link>
            </member>
            <member>
                <link linkend="tree_show">tree_show</link>
            </member>
            <member>
                <link linkend="xmlDump">xmlDump</link>
            </member>
            <member>
                <link linkend="prettyprint">prettyprint</link>
            </member>
            <member>
                <link linkend="editvar">editvar</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
