Xcos help: document xcosPalMove and xcosPalDelete 77/10377/2
Clément DAVID [Thu, 31 Jan 2013 16:53:07 +0000 (17:53 +0100)]
Change-Id: I2b5a1ac8e8cbed632fe0b7dd59b589dea9c77634

scilab/modules/xcos/help/en_US/scilab_utilities_functions/xcosPalDelete.xml [new file with mode: 0644]
scilab/modules/xcos/help/en_US/scilab_utilities_functions/xcosPalMove.xml [new file with mode: 0644]

diff --git a/scilab/modules/xcos/help/en_US/scilab_utilities_functions/xcosPalDelete.xml b/scilab/modules/xcos/help/en_US/scilab_utilities_functions/xcosPalDelete.xml
new file mode 100644 (file)
index 0000000..cca86ed
--- /dev/null
@@ -0,0 +1,64 @@
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="xcosPalDelete" xml:lang="en">
+    <refnamediv>
+        <refname>xcosPalDelete</refname>
+        <refpurpose>Remove an Xcos palette.</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>
+            xcosPalDelete(category);
+        </synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Arguments</title>
+        <variablelist>
+            <varlistentry>
+                <term>category:</term>
+                <listitem>
+                    <para> string array; the category path to delete</para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
+        <title>Description</title>
+        <para>
+            Remove an existing palette.
+        </para>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
+        <programlisting role="example"><![CDATA[
+loadXcosLibs();
+
+// add a palette
+pal = xcosPal("My sum palette");
+pal = xcosPalAddBlock(pal, "SUM_f");
+pal = xcosPalAddBlock(pal, "BIGSOM_f");
+xcosPalAdd(pal);
+
+// remove the palette
+xcosPalDelete("My sum palette")
+   ]]></programlisting>
+    </refsection>
+    <refsection role="see also">
+        <title>See also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="xcosPal">xcosPal</link>
+            </member>
+            <member>
+                <link linkend="xcosPalAdd">xcosPalAdd</link>
+            </member>
+        </simplelist>
+    </refsection>
+    <refsection>
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.4.0</revnumber>
+                <revremark>Function added in Scilab 5.4.0</revremark>
+            </revision>
+        </revhistory>
+    </refsection>
+</refentry>
diff --git a/scilab/modules/xcos/help/en_US/scilab_utilities_functions/xcosPalMove.xml b/scilab/modules/xcos/help/en_US/scilab_utilities_functions/xcosPalMove.xml
new file mode 100644 (file)
index 0000000..28bacde
--- /dev/null
@@ -0,0 +1,73 @@
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="xcosPalMove" xml:lang="en">
+    <refnamediv>
+        <refname>xcosPalMove</refname>
+        <refpurpose>Move a palette from a category to another one.</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>
+            xcosPalMove(source, target);
+        </synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Arguments</title>
+        <variablelist>
+            <varlistentry>
+                <term>source:</term>
+                <listitem>
+                    <para> string array; the source category path</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>target:</term>
+                <listitem>
+                    <para> string array; the target category path</para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
+        <title>Description</title>
+        <para>
+            Move an existing palette.
+        </para>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
+        <programlisting role="example"><![CDATA[
+loadXcosLibs();
+
+// add a palette
+pal = xcosPal("My sum palette");
+pal = xcosPalAddBlock(pal, "SUM_f");
+pal = xcosPalAddBlock(pal, "BIGSOM_f");
+xcosPalAdd(pal);
+
+// remove the palette
+xcosPalMove("My sum palette", ["Custom made" "Sum"]);
+   ]]></programlisting>
+    </refsection>
+    <refsection role="see also">
+        <title>See also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="xcosPal">xcosPal</link>
+            </member>
+            <member>
+                <link linkend="xcosPalAdd">xcosPalAdd</link>
+            </member>
+            <member>
+                <link linkend="xcosPalDelete">xcosPalDelete</link>
+            </member>
+        </simplelist>
+    </refsection>
+    <refsection>
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.4.0</revnumber>
+                <revremark>Function added in Scilab 5.4.0</revremark>
+            </revision>
+        </revhistory>
+    </refsection>
+</refentry>