Uniformisation of the obsolete information 27/8527/2
Sylvestre Ledru [Fri, 3 Aug 2012 14:57:48 +0000 (16:57 +0200)]
Change-Id: I51fdadaba46cfdade4984b73d4c00e332a7adcf0

20 files changed:
scilab/modules/compatibility_functions/help/en_US/mtlb_conv.xml
scilab/modules/fileio/help/en_US/fprintf.xml
scilab/modules/graphics/help/en_US/2d_plot/fcontour2d.xml
scilab/modules/graphics/help/en_US/2d_plot/plot2d1.xml
scilab/modules/graphics/help/en_US/3d_plot/fac3d.xml
scilab/modules/graphics/help/en_US/3d_plot/fcontour.xml
scilab/modules/graphics/help/en_US/alufunctions.xml
scilab/modules/graphics/help/en_US/axes_operations/plotframe.xml
scilab/modules/graphics/help/en_US/clear_pixmap.xml
scilab/modules/graphics/help/en_US/handle/draw.xml
scilab/modules/graphics/help/en_US/show_pixmap.xml
scilab/modules/graphics/help/en_US/style/getsymbol.xml
scilab/modules/graphics/help/en_US/xget.xml
scilab/modules/graphics/help/en_US/xset.xml
scilab/modules/graphics/help/en_US/xsetm.xml
scilab/modules/linear_algebra/help/en_US/gschur.xml
scilab/modules/linear_algebra/help/en_US/gspec.xml
scilab/modules/string/help/en_US/code2str.xml
scilab/modules/string/help/en_US/str2code.xml
scilab/modules/umfpack/help/en_US/rafiter.xml

index 2c82c0f..dcb2a34 100644 (file)
     *
     -->
 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="mtlb_conv">
-  <refnamediv>
-    <refname>mtlb_conv</refname>
-    <refpurpose>
-      Matlab conv emulation function. <emphasis role="bold">This function is obsolete.</emphasis>
-    </refpurpose>
-  </refnamediv>
-  <refsection>
-    <title>Description</title>
-    <para>
-      Matlab <literal>conv</literal> and Scilab <literal>convol</literal> behave differently in some particular cases:
-    </para>
-    <itemizedlist>
-      <listitem>
+    <refnamediv>
+        <refname>mtlb_conv</refname>
+        <refpurpose>
+            Matlab conv emulation function. <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
+    </refnamediv>
+    <refsection>
+        <title>Description</title>
         <para>
-          With column vector inputs: if at least input is a column vector Matlab <literal>conv</literal> returns a column
-          vector but Scilab <literal>convol</literal> always returns a row vector.
+            Matlab <literal>conv</literal> and Scilab <literal>convol</literal> behave differently in some particular cases:
         </para>
-      </listitem>
-    </itemizedlist>
-    <para>
-      The function <literal>mtlb_conv(u,v)</literal> is used by
-      <literal>mfile2sci</literal> to replace <literal>conv(u,v)</literal> when it was not
-      possible to know what were the inputs while porting Matlab code to Scilab. This function will
-      determine the correct semantic at run time. If you want to have a
-      more efficient code it is possible to replace <literal>mtlb_conv</literal> calls:
-    </para>
-    <itemizedlist>
-      <listitem>
+        <itemizedlist>
+            <listitem>
+                <para>
+                    With column vector inputs: if at least input is a column vector Matlab <literal>conv</literal> returns a column
+                    vector but Scilab <literal>convol</literal> always returns a row vector.
+                </para>
+            </listitem>
+        </itemizedlist>
         <para>
-          If <literal>u</literal> and <literal>v</literal> are row vectors,
-          <literal>mtlb_conv(u,v)</literal> may be replaced by <literal>convol(u,v)</literal>
+            The function <literal>mtlb_conv(u,v)</literal> is used by
+            <literal>mfile2sci</literal> to replace <literal>conv(u,v)</literal> when it was not
+            possible to know what were the inputs while porting Matlab code to Scilab. This function will
+            determine the correct semantic at run time. If you want to have a
+            more efficient code it is possible to replace <literal>mtlb_conv</literal> calls:
         </para>
-      </listitem>
-      <listitem>
+        <itemizedlist>
+            <listitem>
+                <para>
+                    If <literal>u</literal> and <literal>v</literal> are row vectors,
+                    <literal>mtlb_conv(u,v)</literal> may be replaced by <literal>convol(u,v)</literal>
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    If <literal>u</literal> or <literal>v</literal> is a column vector,
+                    <literal>mtlb_conv(u,v)</literal> may be replaced by <literal>convol(u,v).'</literal>
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    If <literal>u</literal> and <literal>v</literal> are column vectors,
+                    <literal>mtlb_conv(u,v)</literal> may be replaced by <literal>convol(u,v).'</literal>
+                </para>
+            </listitem>
+        </itemizedlist>
         <para>
-          If <literal>u</literal> or <literal>v</literal> is a column vector,
-          <literal>mtlb_conv(u,v)</literal> may be replaced by <literal>convol(u,v).'</literal>
+            Scilab <literal>convol</literal> sometimes returns values that may be rounded using <literal>clean</literal>
+            to have a closer result from Matlab one.
         </para>
-      </listitem>
-      <listitem>
         <para>
-          If <literal>u</literal> and <literal>v</literal> are column vectors,
-          <literal>mtlb_conv(u,v)</literal> may be replaced by <literal>convol(u,v).'</literal>
+            Caution: <literal>mtlb_conv</literal> has not to be used for hand coded functions.
         </para>
-      </listitem>
-    </itemizedlist>
-    <para>
-      Scilab <literal>convol</literal> sometimes returns values that may be rounded using <literal>clean</literal>
-      to have a closer result from Matlab one.
-    </para>
-    <para>
-      Caution: <literal>mtlb_conv</literal> has not to be used for hand coded functions.
-    </para>
-  </refsection>
-  <refsection role="see also">
-    <title>See Also</title>
-    <simplelist type="inline">
-      <member>
-        <link linkend="clean">clean</link>
-      </member>
-      <member>
-        <link linkend="conv">conv</link>
-      </member>
-    </simplelist>
-  </refsection>
-  <refsection>
-    <title>History</title>
-    <revhistory>
-      <revision>
-        <revnumber>5.4.0</revnumber>
-        <revremark>
-          Function mtlb_conv is obsolete and will be removed in Scilab 5.4.1, use <link linkend="conv">conv</link> instead.
-        </revremark>
-      </revision>
-    </revhistory>
-  </refsection>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="clean">clean</link>
+            </member>
+            <member>
+                <link linkend="conv">conv</link>
+            </member>
+        </simplelist>
+    </refsection>
+    <refsection>
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.4.0</revnumber>
+                <revremark>
+                    Function mtlb_conv is obsolete and will be removed in Scilab 5.4.1, use <link linkend="conv">conv</link> instead.
+                </revremark>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>
index e06e9da..5a084f1 100644 (file)
  *
  -->
 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="fprintf">
-  <refnamediv>
-    <refname>fprintf</refname>
-    <refpurpose>
-      Emulator of C language fprintf function. <emphasis>This function
-        is obsolete
-      </emphasis>
-    </refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>fprintf(file,format,value_1,..,value_n)</synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Arguments</title>
-    <variablelist>
-      <varlistentry>
-        <term>format</term>
-        <listitem>
-          <para>a Scilab string. It specifies a character string combining literal characters with conversion specifications.</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>value_i</term>
-        <listitem>
-          <para>
-            specifies the data to be converted according to the <varname>format</varname> parameter.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>file</term>
-        <listitem>
-          <para>
-            a Scilab string specifying a file name or a logical unit number (see<link linkend="file">file</link>)
-          </para>
-          <para>
-            Note that if <varname>file</varname>=0, the message will be display on standard error stream (stderr).
-          </para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
-  </refsection>
-  <refsection>
-    <title>Description</title>
-    <para>
-      <caution>
-        This function is obsolete, use preferabily the <link
+    <refnamediv>
+        <refname>fprintf</refname>
+        <refpurpose>
+            Emulator of C language fprintf function. <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>fprintf(file,format,value_1,..,value_n)</synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Arguments</title>
+        <variablelist>
+            <varlistentry>
+                <term>format</term>
+                <listitem>
+                    <para>a Scilab string. It specifies a character string combining literal characters with conversion specifications.</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>value_i</term>
+                <listitem>
+                    <para>
+                        specifies the data to be converted according to the <varname>format</varname> parameter.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>file</term>
+                <listitem>
+                    <para>
+                        a Scilab string specifying a file name or a logical unit number (see<link linkend="file">file</link>)
+                    </para>
+                    <para>
+                        Note that if <varname>file</varname>=0, the message will be display on standard error stream (stderr).
+                    </para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
+        <title>Description</title>
+        <para>
+            <caution>
+                This function is obsolete, use preferabily the <link
         linkend="mfprintf">mfprintf</link> function which is much more
-        compatible with the C <function>fprintf</function> functionalities.
-      </caution>
-    </para>
-    <para>
-      The <function>fprintf</function> function converts, formats, and writes
-      its <varname>value</varname> parameters, under control of the <varname>format</varname>
-      parameter, to the file specified by its <varname>file</varname> parameter.
-    </para>
-    <para>
-      The <varname>format</varname> parameter is a character string that contains two
-      types of objects:
-    </para>
-    <variablelist>
-      <varlistentry>
-        <term>Literal characters</term>
-        <listitem>
-          <para>which are copied to the output stream.</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>Conversion specifications</term>
-        <listitem>
-          <para>
-            each of which causes zero or more items to be fetched from the <varname>value</varname> parameter list. See <link linkend="printf_conversion">printf_conversion</link> for details.
-          </para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
-    <para>
-      If any <varname>value</varname>s remain after the entire <varname>format</varname> has been
-      processed, they are ignored.
-    </para>
-  </refsection>
-  <refsection>
-    <title>Examples</title>
-    <programlisting role="example"><![CDATA[ 
+                compatible with the C <function>fprintf</function> functionalities.
+            </caution>
+        </para>
+        <para>
+            The <function>fprintf</function> function converts, formats, and writes
+            its <varname>value</varname> parameters, under control of the <varname>format</varname>
+            parameter, to the file specified by its <varname>file</varname> parameter.
+        </para>
+        <para>
+            The <varname>format</varname> parameter is a character string that contains two
+            types of objects:
+        </para>
+        <variablelist>
+            <varlistentry>
+                <term>Literal characters</term>
+                <listitem>
+                    <para>which are copied to the output stream.</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>Conversion specifications</term>
+                <listitem>
+                    <para>
+                        each of which causes zero or more items to be fetched from the <varname>value</varname> parameter list. See <link linkend="printf_conversion">printf_conversion</link> for details.
+                    </para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+        <para>
+            If any <varname>value</varname>s remain after the entire <varname>format</varname> has been
+            processed, they are ignored.
+        </para>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
+        <programlisting role="example"><![CDATA[ 
 u=file('open',fullfile(TMPDIR,'results'),'unknown') //open the result file
 t=0:0.1:2*%pi;
 for tk=t
@@ -105,40 +103,40 @@ file('close',u) //close the result file
 
 fprintf(0,'My error which is going to be displayed on the stderr') 
  ]]></programlisting>
-  </refsection>
-  <refsection role="see also">
-    <title>See Also</title>
-    <simplelist type="inline">
-      <member>
-        <link linkend="mfprintf">mfprintf</link>
-      </member>
-      <member>
-        <link linkend="string">string</link>
-      </member>
-      <member>
-        <link linkend="print">print</link>
-      </member>
-      <member>
-        <link linkend="write">write</link>
-      </member>
-      <member>
-        <link linkend="format">format</link>
-      </member>
-      <member>
-        <link linkend="disp">disp</link>
-      </member>
-      <member>
-        <link linkend="file">file</link>
-      </member>
-      <member>
-        <link linkend="mprintf">mprintf</link>
-      </member>
-      <member>
-        <link linkend="msprintf">msprintf</link>
-      </member>
-      <member>
-        <link linkend="printf_conversion">printf_conversion</link>
-      </member>
-    </simplelist>
-  </refsection>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="mfprintf">mfprintf</link>
+            </member>
+            <member>
+                <link linkend="string">string</link>
+            </member>
+            <member>
+                <link linkend="print">print</link>
+            </member>
+            <member>
+                <link linkend="write">write</link>
+            </member>
+            <member>
+                <link linkend="format">format</link>
+            </member>
+            <member>
+                <link linkend="disp">disp</link>
+            </member>
+            <member>
+                <link linkend="file">file</link>
+            </member>
+            <member>
+                <link linkend="mprintf">mprintf</link>
+            </member>
+            <member>
+                <link linkend="msprintf">msprintf</link>
+            </member>
+            <member>
+                <link linkend="printf_conversion">printf_conversion</link>
+            </member>
+        </simplelist>
+    </refsection>
 </refentry>
index 0f941f8..d4304d0 100644 (file)
  *
  -->
 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="fcontour2d">
-  <refnamediv>
-    <refname>fcontour2d</refname>
-    <refpurpose>Level curves of a surface defined by a function on a 2D plot (obsolete function)</refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>fcontour2d(xr,yr,f,nz,[style,strf,leg,rect,nax])
-      fcontour2d(xr,yr,f,nz,&lt;opt_args&gt;)
-    </synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Description</title>
-    <para>This function is obsolete. It is now included in the
-      <link linkend="contour2d">contour2d</link> function.
-    </para>
-  </refsection>
+    <refnamediv>
+        <refname>fcontour2d</refname>
+        <refpurpose>
+            Level curves of a surface defined by a function on a 2D plot. <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>fcontour2d(xr,yr,f,nz,[style,strf,leg,rect,nax])
+            fcontour2d(xr,yr,f,nz,&lt;opt_args&gt;)
+        </synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Description</title>
+        <para>This function is obsolete. It is now included in the
+            <link linkend="contour2d">contour2d</link> function.
+        </para>
+    </refsection>
 </refentry>
index bd585f0..5184738 100644 (file)
  *
  -->
 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="plot2d1">
-  <refnamediv>
-    <refname>plot2d1</refname>
-    <refpurpose>2D plot (logarithmic axes)
-      (obsolete)
-    </refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>plot2d1(str,x,y,[style,strf,leg,rect,nax])</synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Arguments</title>
-    <variablelist>
-      <varlistentry>
-        <term>str</term>
-        <listitem>
-          <para>
-            is a string of length three <literal>"abc"</literal>.
-          </para>
-          <variablelist>
+    <refnamediv>
+        <refname>plot2d1</refname>
+        <refpurpose>
+            2D plot (logarithmic axes). <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>plot2d1(str,x,y,[style,strf,leg,rect,nax])</synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Arguments</title>
+        <variablelist>
             <varlistentry>
-              <term>a</term>
-              <listitem>
-                <para>
-                  can have the following values: <literal>e</literal>,
-                  <literal>o</literal> or <literal>g</literal>.
-                </para>
-                <variablelist>
-                  <varlistentry>
-                    <term>e</term>
-                    <listitem>
-                      <para>means "empty". Itspecifies the fact that the value
-                        of <literal>x</literal> is not used (the <literal>x</literal> values
-                        are supposed to be regularly spaced, ie 1:&lt;number of
-                        rows of <literal>y</literal>&gt;). The user must anyway give a
-                        value for <literal>x</literal>, 1 for instance:
-                        <literal>plot2d1("enn",1,y)</literal>.
-                      </para>
-                    </listitem>
-                  </varlistentry>
-                  <varlistentry>
-                    <term>o</term>
-                    <listitem>
-                      <para>means "one". If there are many curves, they all
-                        have the same x-values: <literal>x</literal> is a column
-                        vector of size nl and <literal>y</literal> is a matrix of size
-                        (nl,nc). For example : 
-                        <literal>x=[0:0.1:2*%pi]';plot2d1("onn",x,[sin(x) cos(x)])</literal>.
-                      </para>
-                    </listitem>
-                  </varlistentry>
-                  <varlistentry>
-                    <term>g</term>
-                    <listitem>
-                      <para>
-                        means "general". <literal>x</literal> and <literal>y</literal>
-                        must have the same size (nl,nc). Each column of
-                        <literal>y</literal> is plotted with respect to the
-                        corresponding column of <literal>x</literal>. <literal>nc</literal>
-                        curves are plotted using <literal>nl</literal> points.
-                      </para>
-                    </listitem>
-                  </varlistentry>
-                </variablelist>
-              </listitem>
+                <term>str</term>
+                <listitem>
+                    <para>
+                        is a string of length three <literal>"abc"</literal>.
+                    </para>
+                    <variablelist>
+                        <varlistentry>
+                            <term>a</term>
+                            <listitem>
+                                <para>
+                                    can have the following values: <literal>e</literal>,
+                                    <literal>o</literal> or <literal>g</literal>.
+                                </para>
+                                <variablelist>
+                                    <varlistentry>
+                                        <term>e</term>
+                                        <listitem>
+                                            <para>means "empty". Itspecifies the fact that the value
+                                                of <literal>x</literal> is not used (the <literal>x</literal> values
+                                                are supposed to be regularly spaced, ie 1:&lt;number of
+                                                rows of <literal>y</literal>&gt;). The user must anyway give a
+                                                value for <literal>x</literal>, 1 for instance:
+                                                <literal>plot2d1("enn",1,y)</literal>.
+                                            </para>
+                                        </listitem>
+                                    </varlistentry>
+                                    <varlistentry>
+                                        <term>o</term>
+                                        <listitem>
+                                            <para>means "one". If there are many curves, they all
+                                                have the same x-values: <literal>x</literal> is a column
+                                                vector of size nl and <literal>y</literal> is a matrix of size
+                                                (nl,nc). For example : 
+                                                <literal>x=[0:0.1:2*%pi]';plot2d1("onn",x,[sin(x) cos(x)])</literal>.
+                                            </para>
+                                        </listitem>
+                                    </varlistentry>
+                                    <varlistentry>
+                                        <term>g</term>
+                                        <listitem>
+                                            <para>
+                                                means "general". <literal>x</literal> and <literal>y</literal>
+                                                must have the same size (nl,nc). Each column of
+                                                <literal>y</literal> is plotted with respect to the
+                                                corresponding column of <literal>x</literal>. <literal>nc</literal>
+                                                curves are plotted using <literal>nl</literal> points.
+                                            </para>
+                                        </listitem>
+                                    </varlistentry>
+                                </variablelist>
+                            </listitem>
+                        </varlistentry>
+                        <varlistentry>
+                            <term>b, c</term>
+                            <listitem>
+                                <para>
+                                    can have the values <literal>n</literal> (normal) or
+                                    <literal>l</literal> (logarithmic).
+                                </para>
+                                <variablelist>
+                                    <varlistentry>
+                                        <term>b=l</term>
+                                        <listitem>
+                                            <para>a logarithmic axis is used on the x-axis</para>
+                                        </listitem>
+                                    </varlistentry>
+                                    <varlistentry>
+                                        <term>c=l</term>
+                                        <listitem>
+                                            <para>a logarithmic axis is used on the y-axis</para>
+                                        </listitem>
+                                    </varlistentry>
+                                </variablelist>
+                            </listitem>
+                        </varlistentry>
+                    </variablelist>
+                </listitem>
             </varlistentry>
             <varlistentry>
-              <term>b, c</term>
-              <listitem>
-                <para>
-                  can have the values <literal>n</literal> (normal) or
-                  <literal>l</literal> (logarithmic).
-                </para>
-                <variablelist>
-                  <varlistentry>
-                    <term>b=l</term>
-                    <listitem>
-                      <para>a logarithmic axis is used on the x-axis</para>
-                    </listitem>
-                  </varlistentry>
-                  <varlistentry>
-                    <term>c=l</term>
-                    <listitem>
-                      <para>a logarithmic axis is used on the y-axis</para>
-                    </listitem>
-                  </varlistentry>
-                </variablelist>
-              </listitem>
+                <term>x,y,[style,strf,leg,rect,nax]</term>
+                <listitem>
+                    <para>these arguments have the same meaning as in the
+                        <literal>plot2d</literal> function.
+                    </para>
+                </listitem>
             </varlistentry>
-          </variablelist>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>x,y,[style,strf,leg,rect,nax]</term>
-        <listitem>
-          <para>these arguments have the same meaning as in the
-            <literal>plot2d</literal> function.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>opt_args</term>
-        <listitem>
-          <para>these arguments have the same meaning as in the
-            <literal>plot2d</literal> function.
-          </para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
-  </refsection>
-  <refsection>
-    <title>Description</title>
-    <para>
-      This function is obsolete. USE <literal>plot2d</literal> INSTEAD !!
-    </para>
-    <para>
-      <literal>plot2d1</literal> plots a set of 2D curves. It is the same as
-      <literal>plot2d</literal> but with one more argument <literal>str</literal> which
-      enables logarithmic axis. Moreover, it allows to specify only one column
-      vector for <literal>x</literal> when it is the same for all the curves.
-    </para>
-    <para>By default, successive plots are superposed. To clear the previous
-      plot, use <literal>clf</literal>.
-    </para>
-    <para>
-      Enter the command <literal>plot2d1()</literal> to see a demo.
-    </para>
-  </refsection>
-  <refsection>
-    <title>Sample</title>
-    <scilab:image>plot2d1();</scilab:image>
-  </refsection>
-  <refsection>
-    <title>Examples</title>
-    <programlisting role="example"><![CDATA[ 
+            <varlistentry>
+                <term>opt_args</term>
+                <listitem>
+                    <para>these arguments have the same meaning as in the
+                        <literal>plot2d</literal> function.
+                    </para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
+        <title>Description</title>
+        <para>
+            This function is obsolete. USE <literal>plot2d</literal> INSTEAD !!
+        </para>
+        <para>
+            <literal>plot2d1</literal> plots a set of 2D curves. It is the same as
+            <literal>plot2d</literal> but with one more argument <literal>str</literal> which
+            enables logarithmic axis. Moreover, it allows to specify only one column
+            vector for <literal>x</literal> when it is the same for all the curves.
+        </para>
+        <para>By default, successive plots are superposed. To clear the previous
+            plot, use <literal>clf</literal>.
+        </para>
+        <para>
+            Enter the command <literal>plot2d1()</literal> to see a demo.
+        </para>
+    </refsection>
+    <refsection>
+        <title>Sample</title>
+        <scilab:image>plot2d1();</scilab:image>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
+        <programlisting role="example"><![CDATA[ 
 // multiple plot without giving x
 x=[0:0.1:2*%pi]';
 plot2d1("enn",1,[sin(x) sin(2*x) sin(3*x)])
@@ -156,25 +156,25 @@ plot2d1("onn",x,[sin(x) sin(2*x) sin(3*x)])
 x=[0.1:0.1:3]'; clf()
 plot2d1("oll",x,[exp(x) exp(x^2) exp(x^3)])
  ]]></programlisting>
-  </refsection>
-  <refsection role="see also">
-    <title>See Also</title>
-    <simplelist type="inline">
-      <member>
-        <link linkend="plot2d">plot2d</link>
-      </member>
-      <member>
-        <link linkend="plot2d2">plot2d2</link>
-      </member>
-      <member>
-        <link linkend="plot2d3">plot2d3</link>
-      </member>
-      <member>
-        <link linkend="plot2d4">plot2d4</link>
-      </member>
-      <member>
-        <link linkend="clf">clf</link>
-      </member>
-    </simplelist>
-  </refsection>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="plot2d">plot2d</link>
+            </member>
+            <member>
+                <link linkend="plot2d2">plot2d2</link>
+            </member>
+            <member>
+                <link linkend="plot2d3">plot2d3</link>
+            </member>
+            <member>
+                <link linkend="plot2d4">plot2d4</link>
+            </member>
+            <member>
+                <link linkend="clf">clf</link>
+            </member>
+        </simplelist>
+    </refsection>
 </refentry>
index 95ab8dd..49e7592 100644 (file)
  *
  -->
 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="fac3d">
-  <refnamediv>
-    <refname>fac3d</refname>
-    <refpurpose>3D plot of a surface (obsolete)  </refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>fac3d(x,y,z,[theta,alpha,leg,flag,ebox])
-      fac3d1(x,y,z,[theta,alpha,leg,flag,ebox])
-    </synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Description</title>
-    <para>
-      These functions are obsolete and have been replaced by
-      <literal>plot3d</literal> and <literal>plot3d1</literal>.
-    </para>
-  </refsection>
-  <refsection role="see also">
-    <title>See Also</title>
-    <simplelist type="inline">
-      <member>
-        <link linkend="plot3d">plot3d</link>
-      </member>
-      <member>
-        <link linkend="plot3d1">plot3d1</link>
-      </member>
-    </simplelist>
-  </refsection>
+    <refnamediv>
+        <refname>fac3d</refname>
+        <refpurpose>
+            3D plot of a surface. <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>fac3d(x,y,z,[theta,alpha,leg,flag,ebox])
+            fac3d1(x,y,z,[theta,alpha,leg,flag,ebox])
+        </synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Description</title>
+        <para>
+            These functions are obsolete and have been replaced by
+            <literal>plot3d</literal> and <literal>plot3d1</literal>.
+        </para>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="plot3d">plot3d</link>
+            </member>
+            <member>
+                <link linkend="plot3d1">plot3d1</link>
+            </member>
+        </simplelist>
+    </refsection>
 </refentry>
index 5dc1fa0..25dc2c9 100644 (file)
  *
  -->
 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="fcontour">
-  <refnamediv>
-    <refname>fcontour</refname>
-    <refpurpose>level curves on a 3D surface defined by a
-      function (obsolete function)
-    </refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>fcontour(xr,yr,f,nz,[theta,alpha,leg,flag,ebox,zlev])
-      fcontour(xr,yr,f,nz,&lt;opt_args&gt;)
-    </synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Description</title>
-    <para>This function is obsolete. It is now included in the
-      <link linkend="contour">contour</link> function.
-    </para>
-  </refsection>
+    <refnamediv>
+        <refname>fcontour</refname>
+        <refpurpose>level curves on a 3D surface defined by a
+            function. <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>fcontour(xr,yr,f,nz,[theta,alpha,leg,flag,ebox,zlev])
+            fcontour(xr,yr,f,nz,&lt;opt_args&gt;)
+        </synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Description</title>
+        <para>This function is obsolete. It is now included in the
+            <link linkend="contour">contour</link> function.
+        </para>
+    </refsection>
 </refentry>
index eca7d50..92832ae 100644 (file)
  *
  -->
 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="alufunctions">
-  <refnamediv>
-    <refname>alufunctions</refname>
-    <refpurpose>
-      pixel drawing functions. <emphasis role="bold">This function is obsolete.</emphasis>
-    </refpurpose>
-  </refnamediv>
-  <refsection>
-    <title>Description</title>
-    <para>
-      src is the source ie the "value of the pixel" which we want to draw.
-      dst is the destination ie "value of the pixel" which is already drawn.
-    </para>
-    <variablelist>
-      <varlistentry>
-        <term>0</term>
-        <listitem>
-          <para>clear ie "0"</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>1</term>
-        <listitem>
-          <para>and ie "src AND dst"</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>2</term>
-        <listitem>
-          <para>and reverse ie "src AND NOT dst"</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>3</term>
-        <listitem>
-          <para>copy ie "src"</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>4</term>
-        <listitem>
-          <para>and inverted ie "(NOT src) AND dst"</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>5</term>
-        <listitem>
-          <para>noop ie "dst"</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>6</term>
-        <listitem>
-          <para>xor ie "src XOR dst"</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>7</term>
-        <listitem>
-          <para>or ie "src OR dst"</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>8</term>
-        <listitem>
-          <para>nor ie "(NOT src) AND (NOT dst)"</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>9</term>
-        <listitem>
-          <para>equiv ie "(NOT src) XOR dst"</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>10</term>
-        <listitem>
-          <para>invert ie "NOT dst"</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>11</term>
-        <listitem>
-          <para>or reverse ie "src OR (NOT dst)"</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>12</term>
-        <listitem>
-          <para>copy inverted ie "NOT src"</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>13</term>
-        <listitem>
-          <para>or inverted ie "(NOT src) OR dst"</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>14</term>
-        <listitem>
-          <para>nand ie "(NOT src) OR (NOT dst)"</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>15</term>
-        <listitem>
-          <para>set ie "1"</para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
-  </refsection>
+    <refnamediv>
+        <refname>alufunctions</refname>
+        <refpurpose>
+            pixel drawing functions. <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
+    </refnamediv>
+    <refsection>
+        <title>Description</title>
+        <para>
+            src is the source ie the "value of the pixel" which we want to draw.
+            dst is the destination ie "value of the pixel" which is already drawn.
+        </para>
+        <variablelist>
+            <varlistentry>
+                <term>0</term>
+                <listitem>
+                    <para>clear ie "0"</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>1</term>
+                <listitem>
+                    <para>and ie "src AND dst"</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>2</term>
+                <listitem>
+                    <para>and reverse ie "src AND NOT dst"</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>3</term>
+                <listitem>
+                    <para>copy ie "src"</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>4</term>
+                <listitem>
+                    <para>and inverted ie "(NOT src) AND dst"</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>5</term>
+                <listitem>
+                    <para>noop ie "dst"</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>6</term>
+                <listitem>
+                    <para>xor ie "src XOR dst"</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>7</term>
+                <listitem>
+                    <para>or ie "src OR dst"</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>8</term>
+                <listitem>
+                    <para>nor ie "(NOT src) AND (NOT dst)"</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>9</term>
+                <listitem>
+                    <para>equiv ie "(NOT src) XOR dst"</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>10</term>
+                <listitem>
+                    <para>invert ie "NOT dst"</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>11</term>
+                <listitem>
+                    <para>or reverse ie "src OR (NOT dst)"</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>12</term>
+                <listitem>
+                    <para>copy inverted ie "NOT src"</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>13</term>
+                <listitem>
+                    <para>or inverted ie "(NOT src) OR dst"</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>14</term>
+                <listitem>
+                    <para>nand ie "(NOT src) OR (NOT dst)"</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>15</term>
+                <listitem>
+                    <para>set ie "1"</para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
 </refentry>
index eec9f4b..dce0455 100644 (file)
  *
  -->
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="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" version="5.0-subset Scilab" xml:id="plotframe" xml:lang="en">
-  <refnamediv>
-    <refname>plotframe</refname>
-    <refpurpose>
-      plot a frame with scaling and grids. <emphasis role="bold">This function is obsolete.</emphasis>
-    </refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>plotframe(rect,tics,[arg_opt1,arg_opt2,arg_opt3])
-      plotframe(rect,&lt;opts_args&gt;)
-    </synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Arguments</title>
-    <variablelist>
-      <varlistentry>
-        <term>rect</term>
-        <listitem>
-          <para>
-            vector <literal>[xmin,ymin,xmax,ymax]</literal>.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>tics</term>
-        <listitem>
-          <para>
-            vector <literal>[nx,mx,ny,my]</literal> where <literal>mx,
-              nx
-            </literal>
-            (resp. <literal>my, ny</literal>) are the number of
-            x-axis (resp. y-axis) intervals and subintervals.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>arg_optX</term>
-        <listitem>
-          <para>optional arguments up to three and chosen among.</para>
-          <variablelist>
+    <refnamediv>
+        <refname>plotframe</refname>
+        <refpurpose>
+            plot a frame with scaling and grids. <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>plotframe(rect,tics,[arg_opt1,arg_opt2,arg_opt3])
+            plotframe(rect,&lt;opts_args&gt;)
+        </synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Arguments</title>
+        <variablelist>
             <varlistentry>
-              <term>flags</term>
-              <listitem>
-                <para>
-                  vector <literal>[wantgrids,findbounds]</literal> where
-                  <literal>wantgrids</literal> is a boolean variable
-                  (<literal>%t</literal> or <literal>%f</literal>) which
-                  indicates gridding. <literal>findbounds</literal> is a boolean
-                  variable. If <literal>findbounds</literal> is
-                  <literal>%t</literal>, the bounds given in
-                  <literal>rect</literal> are allowed to be slightly modified
-                  (in fact always increased) in order to have simpler
-                  graduations: then <literal>tics(2)</literal> and
-                  <literal>tics(4)</literal> are ignored.
-                </para>
-              </listitem>
+                <term>rect</term>
+                <listitem>
+                    <para>
+                        vector <literal>[xmin,ymin,xmax,ymax]</literal>.
+                    </para>
+                </listitem>
             </varlistentry>
             <varlistentry>
-              <term>Captions</term>
-              <listitem>
-                <para>vector of 3 strings
-                  <literal>[title,x-leg,y-leg]</literal> corresponding
-                  respectively to the title of the plot and the captions on the
-                  x-axis and the y-axis. Warning: the upper-case "C" is important.
-                </para>
-              </listitem>
+                <term>tics</term>
+                <listitem>
+                    <para>
+                        vector <literal>[nx,mx,ny,my]</literal> where <literal>mx,
+                            nx
+                        </literal>
+                        (resp. <literal>my, ny</literal>) are the number of
+                        x-axis (resp. y-axis) intervals and subintervals.
+                    </para>
+                </listitem>
             </varlistentry>
             <varlistentry>
-              <term>subwin</term>
-              <listitem>
-                <para>a vector of size 4 defining the sub window. The sub
-                  window is specified with the parameter
-                  <literal>subwin=[x,y,w,h]</literal> (upper-left, width,
-                  height). The values in <literal>subwin</literal> are specified
-                  using proportion of the width or height of the current
-                  graphics window (see <literal>xsetech</literal>).
-                </para>
-              </listitem>
+                <term>arg_optX</term>
+                <listitem>
+                    <para>optional arguments up to three and chosen among.</para>
+                    <variablelist>
+                        <varlistentry>
+                            <term>flags</term>
+                            <listitem>
+                                <para>
+                                    vector <literal>[wantgrids,findbounds]</literal> where
+                                    <literal>wantgrids</literal> is a boolean variable
+                                    (<literal>%t</literal> or <literal>%f</literal>) which
+                                    indicates gridding. <literal>findbounds</literal> is a boolean
+                                    variable. If <literal>findbounds</literal> is
+                                    <literal>%t</literal>, the bounds given in
+                                    <literal>rect</literal> are allowed to be slightly modified
+                                    (in fact always increased) in order to have simpler
+                                    graduations: then <literal>tics(2)</literal> and
+                                    <literal>tics(4)</literal> are ignored.
+                                </para>
+                            </listitem>
+                        </varlistentry>
+                        <varlistentry>
+                            <term>Captions</term>
+                            <listitem>
+                                <para>vector of 3 strings
+                                    <literal>[title,x-leg,y-leg]</literal> corresponding
+                                    respectively to the title of the plot and the captions on the
+                                    x-axis and the y-axis. Warning: the upper-case "C" is important.
+                                </para>
+                            </listitem>
+                        </varlistentry>
+                        <varlistentry>
+                            <term>subwin</term>
+                            <listitem>
+                                <para>a vector of size 4 defining the sub window. The sub
+                                    window is specified with the parameter
+                                    <literal>subwin=[x,y,w,h]</literal> (upper-left, width,
+                                    height). The values in <literal>subwin</literal> are specified
+                                    using proportion of the width or height of the current
+                                    graphics window (see <literal>xsetech</literal>).
+                                </para>
+                            </listitem>
+                        </varlistentry>
+                    </variablelist>
+                </listitem>
             </varlistentry>
-          </variablelist>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>&lt;opts_args&gt;</term>
-        <listitem>
-          <para>
-            This represents a sequence of statements <emphasis role="bold">key1=value1</emphasis>,<emphasis role="bold">
-              key2=value2
-            </emphasis>
-            ,... where <emphasis role="bold">key1</emphasis>, <emphasis role="bold">key2</emphasis>,... can be one of the following:
-            <emphasis role="bold">tics</emphasis>, <emphasis role="bold">flags</emphasis>, <emphasis role="bold">captions</emphasis> ou <emphasis role="bold">subwin</emphasis>. These arguments have the same meaning
-            as the ones used in the first form of the routine.
-          </para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
-  </refsection>
-  <refsection>
-    <title>Description</title>
-    <para>
-      <literal>plotframe</literal> is used with 2D plotting functions
-      <link linkend="plot2d">plot2d</link>, <link linkend="plot2d1">plot2d1</link>,... to set a graphics frame. It must be
-      used before <literal>plot2d</literal> which should be invoked with the
-      "000" superposition mode.
-    </para>
-    <para>
-      <emphasis role="bold">This function is obsolete.</emphasis>
-    </para>
-  </refsection>
-  <refsection>
-    <title>Examples</title>
-    <programlisting role="example"><![CDATA[ 
+            <varlistentry>
+                <term>&lt;opts_args&gt;</term>
+                <listitem>
+                    <para>
+                        This represents a sequence of statements <emphasis role="bold">key1=value1</emphasis>,<emphasis role="bold">
+                            key2=value2
+                        </emphasis>
+                        ,... where <emphasis role="bold">key1</emphasis>, <emphasis role="bold">key2</emphasis>,... can be one of the following:
+                        <emphasis role="bold">tics</emphasis>, <emphasis role="bold">flags</emphasis>, <emphasis role="bold">captions</emphasis> ou <emphasis role="bold">subwin</emphasis>. These arguments have the same meaning
+                        as the ones used in the first form of the routine.
+                    </para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
+        <title>Description</title>
+        <para>
+            <literal>plotframe</literal> is used with 2D plotting functions
+            <link linkend="plot2d">plot2d</link>, <link linkend="plot2d1">plot2d1</link>,... to set a graphics frame. It must be
+            used before <literal>plot2d</literal> which should be invoked with the
+            "000" superposition mode.
+        </para>
+        <para>
+            <emphasis role="bold">This function is obsolete..</emphasis>
+        </para>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
+        <programlisting role="example"><![CDATA[ 
 x=[-0.3:0.8:27.3]';
 y=rand(x);
 rect=[min(x),min(y),max(x),max(y)];
@@ -139,19 +139,19 @@ plotframe(rect,flags=[%f,%t],tics=tics,..
           subwin=[0.5,0.5,0.5,0.5])
 plot2d(x,y,5,"000")
  ]]></programlisting>
-  </refsection>
-  <refsection role="see also">
-    <title>See Also</title>
-    <simplelist type="inline">
-      <member>
-        <link linkend="plot2d">plot2d</link>
-      </member>
-      <member>
-        <link linkend="graduate">graduate</link>
-      </member>
-      <member>
-        <link linkend="xsetech">xsetech</link>
-      </member>
-    </simplelist>
-  </refsection>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="plot2d">plot2d</link>
+            </member>
+            <member>
+                <link linkend="graduate">graduate</link>
+            </member>
+            <member>
+                <link linkend="xsetech">xsetech</link>
+            </member>
+        </simplelist>
+    </refsection>
 </refentry>
index fe0f9be..98686dd 100644 (file)
  *
  -->
 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="clear_pixmap">
-  <refnamediv>
-    <refname>clear_pixmap</refname>
-    <refpurpose>erase the pixmap
-      buffer <emphasis role="bold">This function is obsolete.</emphasis>
-    </refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>clear_pixmap()</synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Description</title>
-    <para>
-      If a graphic window <literal>pixmap</literal> property is <literal>"on"</literal>
-      the drawings are send to a pixmap memory instead of the screen display.
-    </para>
-    <para/>
-    <para>
-      The <literal>clear_pixmap()</literal> instruction erase the pixmap, but not
-      the screen.
-    </para>
-    <para/>
-    <para>The pixmap mode can be used to obtain smooth animations.</para>
-   <para>
-      WARNING: This function is obsolete from Scilab 5.4.0 and is going to be removed with Scilab 5.4.1 Please use <link linkend="drawlater">drawlater</link>/<link linkend="drawnow">drawnow</link> instead.
-    </para>
-  </refsection>
-  <refsection role="see also">
-    <title>See Also</title>
-    <simplelist type="inline">
-      <member>
-        <link linkend="figure_properties">figure_properties</link>
-      </member>
-      <member>
-        <link linkend="show_pixmap">show_pixmap</link>
-      </member>
-      <member>
-        <link linkend="drawlater">drawlater</link>
-      </member>
-      <member>
-        <link linkend="drawnow">drawnow</link>
-      </member>
-    </simplelist>
-  </refsection>
-  <refsection>
-    <title>History</title>
-    <revhistory>
-      <revision>
-        <revnumber>5.4.0</revnumber>
-        <revremark>Function clear_pixmap is obsolete.</revremark>
-      </revision>
-    </revhistory>
-  </refsection>
+    <refnamediv>
+        <refname>clear_pixmap</refname>
+        <refpurpose>erase the pixmap
+            buffer <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>clear_pixmap()</synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Description</title>
+        <para>
+            If a graphic window <literal>pixmap</literal> property is <literal>"on"</literal>
+            the drawings are send to a pixmap memory instead of the screen display.
+        </para>
+        <para/>
+        <para>
+            The <literal>clear_pixmap()</literal> instruction erase the pixmap, but not
+            the screen.
+        </para>
+        <para/>
+        <para>The pixmap mode can be used to obtain smooth animations.</para>
+        <para>
+            WARNING: This function is obsolete from Scilab 5.4.0 and is going to be removed with Scilab 5.4.1. Please use <link linkend="drawlater">drawlater</link>/<link linkend="drawnow">drawnow</link> instead.
+        </para>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="figure_properties">figure_properties</link>
+            </member>
+            <member>
+                <link linkend="show_pixmap">show_pixmap</link>
+            </member>
+            <member>
+                <link linkend="drawlater">drawlater</link>
+            </member>
+            <member>
+                <link linkend="drawnow">drawnow</link>
+            </member>
+        </simplelist>
+    </refsection>
+    <refsection>
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.4.0</revnumber>
+                <revremark>Function clear_pixmap is obsolete.</revremark>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>
index 617e01d..a312aca 100644 (file)
  *
  -->
 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="draw">
-  <refnamediv>
-    <refname>draw</refname>
-    <refpurpose>draw an entity. <emphasis role="bold">This function is obsolete.</emphasis></refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>draw()
-      draw(h)
-    </synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Arguments</title>
-    <variablelist>
-      <varlistentry>
-        <term>h</term>
-        <listitem>
-          <para>
-            a handle, the handle on an entity to draw. <literal>h</literal> can
-            be a vector of handles, in which case all objects identified by h(i)
-            will be drawn.
-          </para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
-  </refsection>
-  <refsection>
-    <title>Description</title>
-    <para>
-      This function can be used to draw entities specified by <literal>h</literal>
-      even if its parent figure <literal>immediate_drawing</literal> property is
-      <literal>"off"</literal>. If no argument is specified, the <literal>current object</literal>
-      is drawn. Note that the window must not be resized ; if not,
-      those objects are hidden back.
-    </para>
-    <para>
-      WARNING: This function is obsolete from Scilab 5.4.0 and is going to be removed with Scilab 5.4.1.
-    </para>
-  </refsection>
-  <refsection>
-    <title>Examples</title>
-    <para>
-      Those two exemples below behave the same way hiding and showing objects.
-    </para>
-    <para>
-    <programlisting role="example"><![CDATA[
+    <refnamediv>
+        <refname>draw</refname>
+        <refpurpose>
+            draw an entity. <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>draw()
+            draw(h)
+        </synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Arguments</title>
+        <variablelist>
+            <varlistentry>
+                <term>h</term>
+                <listitem>
+                    <para>
+                        a handle, the handle on an entity to draw. <literal>h</literal> can
+                        be a vector of handles, in which case all objects identified by h(i)
+                        will be drawn.
+                    </para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
+        <title>Description</title>
+        <para>
+            This function can be used to draw entities specified by <literal>h</literal>
+            even if its parent figure <literal>immediate_drawing</literal> property is
+            <literal>"off"</literal>. If no argument is specified, the <literal>current object</literal>
+            is drawn. Note that the window must not be resized ; if not,
+            those objects are hidden back.
+        </para>
+        <para>
+            WARNING: Obsolete function.from Scilab 5.4.0 and is going to be removed with Scilab 5.4.1.
+        </para>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
+        <para>
+            Those two exemples below behave the same way hiding and showing objects.
+        </para>
+        <para>
+            <programlisting role="example"><![CDATA[
 subplot(212)
 a=gca();
 plot2d
@@ -76,9 +78,9 @@ drawnow // ...now!
 
 e.children(1).visible='on';
  ]]></programlisting>
-    </para>
-    <para>
-    <programlisting role="example"><![CDATA[
+        </para>
+        <para>
+            <programlisting role="example"><![CDATA[
 subplot(212)
 a=gca();
 plot2d();
@@ -103,35 +105,35 @@ a.axes_visible = "on";
 
 e.children(1).visible='on'; // Make last polyline visible
  ]]></programlisting>
-    </para>
-  </refsection>
-  <refsection role="see also">
-    <title>See Also</title>
-    <simplelist type="inline">
-      <member>
-        <link linkend="get">get</link>
-      </member>
-      <member>
-        <link linkend="set">set</link>
-      </member>
-      <member>
-        <link linkend="drawnow">drawnow</link>
-      </member>
-      <member>
-        <link linkend="drawlater">drawlater</link>
-      </member>
-      <member>
-        <link linkend="graphics_entities">graphics_entities</link>
-      </member>
-    </simplelist>
-  </refsection>
-  <refsection>
-    <title>History</title>
-    <revhistory>
-      <revision>
-        <revnumber>5.4.0</revnumber>
-        <revremark>Function draw is obsolete.</revremark>
-      </revision>
-    </revhistory>
-  </refsection>
+        </para>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="get">get</link>
+            </member>
+            <member>
+                <link linkend="set">set</link>
+            </member>
+            <member>
+                <link linkend="drawnow">drawnow</link>
+            </member>
+            <member>
+                <link linkend="drawlater">drawlater</link>
+            </member>
+            <member>
+                <link linkend="graphics_entities">graphics_entities</link>
+            </member>
+        </simplelist>
+    </refsection>
+    <refsection>
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.4.0</revnumber>
+                <revremark>Function draw is obsolete.</revremark>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>
index b17c2b6..c18112a 100644 (file)
  *
  -->
 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="show_pixmap">
-  <refnamediv>
-    <refname>show_pixmap</refname>
-    <refpurpose>send the pixmap buffer to the
-      screen <emphasis role="bold">This function is obsolete.</emphasis>
-    </refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>show_pixmap()</synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Description</title>
-    <para>
-      If a graphic window <literal>pixmap</literal> property is <literal>"on"</literal>
-      the drawings are send to a pixmap memory instead of the screen
-      display.
-    </para>
-    <para>
-      The <literal>show_pixmap()</literal> instruction send the pixmap to the
-      screen.
-    </para>
-    <para>The pixmap mode can be used to obtain smooth animations. This property
-      can be found among the figure entity fields (see
-      <link linkend="figure_properties">figure_properties</link>).
-    </para>
-    <para>
-      WARNING: This function is obsolete from Scilab 5.4.0 and is going to be removed with Scilab 5.4.1 Please use <link linkend="drawlater">drawlater</link>/<link linkend="drawnow">drawnow</link> instead.
-    </para>
-  </refsection>
-  <refsection>
-    <title>Examples</title>
-    <programlisting role="example"><![CDATA[
+    <refnamediv>
+        <refname>show_pixmap</refname>
+        <refpurpose>send the pixmap buffer to the
+            screen <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>show_pixmap()</synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Description</title>
+        <para>
+            If a graphic window <literal>pixmap</literal> property is <literal>"on"</literal>
+            the drawings are send to a pixmap memory instead of the screen
+            display.
+        </para>
+        <para>
+            The <literal>show_pixmap()</literal> instruction send the pixmap to the
+            screen.
+        </para>
+        <para>The pixmap mode can be used to obtain smooth animations. This property
+            can be found among the figure entity fields (see
+            <link linkend="figure_properties">figure_properties</link>).
+        </para>
+        <para>
+            WARNING: Obsolete function.from Scilab 5.4.0 and is going to be removed with Scilab 5.4.1 Please use <link linkend="drawlater">drawlater</link>/<link linkend="drawnow">drawnow</link> instead.
+        </para>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
+        <programlisting role="example"><![CDATA[
 f=gcf();
 f.pixmap='on'; //set the pixmap mode
 a=gca();
@@ -64,31 +64,31 @@ for k=1:1000
   xpause(10000)
 end
  ]]></programlisting>
-  </refsection>
-  <refsection role="see also">
-    <title>See Also</title>
-    <simplelist type="inline">
-      <member>
-        <link linkend="figure_properties">figure_properties</link>
-      </member>
-      <member>
-        <link linkend="clear_pixmap">clear_pixmap</link>
-      </member>
-      <member>
-        <link linkend="drawlater">drawlater</link>
-      </member>
-      <member>
-        <link linkend="drawnow">drawnow</link>
-      </member>
-    </simplelist>
-  </refsection>
-  <refsection>
-    <title>History</title>
-    <revhistory>
-      <revision>
-        <revnumber>5.4.0</revnumber>
-        <revremark>Function show_pixmap is obsolete.</revremark>
-      </revision>
-    </revhistory>
-  </refsection>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="figure_properties">figure_properties</link>
+            </member>
+            <member>
+                <link linkend="clear_pixmap">clear_pixmap</link>
+            </member>
+            <member>
+                <link linkend="drawlater">drawlater</link>
+            </member>
+            <member>
+                <link linkend="drawnow">drawnow</link>
+            </member>
+        </simplelist>
+    </refsection>
+    <refsection>
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.4.0</revnumber>
+                <revremark>Function show_pixmap is obsolete.</revremark>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>
index a49ee47..dae7ece 100644 (file)
  *
  -->
 <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" version="5.0-subset Scilab" xml:id="getsymbol" xml:lang="en">
-  <refnamediv>
-    <refname>getsymbol</refname>
-    <refpurpose>
-      dialog to select a symbol and its size. <emphasis role="bold">Obsolete function</emphasis>
-    </refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>c=getsymbol([title])</synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Arguments</title>
-    <variablelist>
-      <varlistentry>
-        <term>title</term>
-        <listitem>
-          <para>string, dialog title.</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>c</term>
-        <listitem>
-          <para>
-            vector of size 2 <literal>[n,sz]</literal>.
-          </para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
-  </refsection>
-  <refsection>
-    <title>Description</title>
-    <para>
-      This function designed to work with the <link linkend="xset">xset</link> function <emphasis role="bold">is also
-        obsolete
-      </emphasis>
-      .Use the property editor <link linkend="ged">ged</link> instead.
-    </para>
-    <para>
-      <literal>getsymbol</literal> opens a dialog choice box with title
-      <literal>title</literal> if given where the user can select a symbol and
-      its size. <literal>getsymbol</literal> returns the id of the mark
-      <literal>n</literal> and the id of its size <literal>sz</literal>.
-    </para>
-  </refsection>
-  <refsection role="see also">
-    <title>See Also</title>
-    <simplelist type="inline">
-      <member>
-        <link linkend="ged">ged</link>
-      </member>
-      <member>
-        <link linkend="set">set</link>
-      </member>
-      <member>
-        <link linkend="polyline_properties">segs_properties</link>
-      </member>
-      <member>
-        <link linkend="segs_properties">segs_properties</link>
-      </member>
-    </simplelist>
-  </refsection>
+    <refnamediv>
+        <refname>getsymbol</refname>
+        <refpurpose>
+            dialog to select a symbol and its size. <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>c=getsymbol([title])</synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Arguments</title>
+        <variablelist>
+            <varlistentry>
+                <term>title</term>
+                <listitem>
+                    <para>string, dialog title.</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>c</term>
+                <listitem>
+                    <para>
+                        vector of size 2 <literal>[n,sz]</literal>.
+                    </para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
+        <title>Description</title>
+        <para>
+            This function designed to work with the <link linkend="xset">xset</link> function <emphasis role="bold">is also
+                obsolete
+            </emphasis>
+            .Use the property editor <link linkend="ged">ged</link> instead.
+        </para>
+        <para>
+            <literal>getsymbol</literal> opens a dialog choice box with title
+            <literal>title</literal> if given where the user can select a symbol and
+            its size. <literal>getsymbol</literal> returns the id of the mark
+            <literal>n</literal> and the id of its size <literal>sz</literal>.
+        </para>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="ged">ged</link>
+            </member>
+            <member>
+                <link linkend="set">set</link>
+            </member>
+            <member>
+                <link linkend="polyline_properties">segs_properties</link>
+            </member>
+            <member>
+                <link linkend="segs_properties">segs_properties</link>
+            </member>
+        </simplelist>
+    </refsection>
 </refentry>
index 3b8cd70..81cfc5c 100644 (file)
  *
  -->
 <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" version="5.0-subset Scilab" xml:id="xget" xml:lang="en">
-  <refnamediv>
-    <refname>xget</refname>
-    <refpurpose>
-      get current values of the graphics context. <emphasis role="bold">This function is obsolete.</emphasis>
-    </refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>[x1]=xget(str,[flag])
-      xget()
-    </synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Arguments</title>
-    <variablelist>
-      <varlistentry>
-        <term>str</term>
-        <listitem>
-          <para>string.</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>flag</term>
-        <listitem>
-          <para>optional. Set to 1 gives a verbose mode.</para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
-  </refsection>
-  <refsection>
-    <title>Description</title>
-    <para>
-      <emphasis role="bold">Warning this function is obsolete</emphasis>.
-      Use the Scilab graphic objetcs representation instead (see the <link linkend="set">set</link> and <link linkend="get">get</link> functions as
-      well as the <link linkend="graphics_entities">graphics_entities</link>
-      help page).
-    </para>
-    <para>This function is used to get values from the graphics context on the
-      topic specified by the string <literal>str</literal>. When called with no
-      argument, a choice menu is created showing the current values and changes
-      can be performed through toggle buttons.
-    </para>
-    <variablelist>
-      <varlistentry>
-        <term>str=xget("auto clear")</term>
-        <listitem>
-          <para>
-            Get the auto clear status (<literal>"on"</literal> or
-            <literal>"off"</literal>).
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>color=xget("background")</term>
-        <listitem>
-          <para>Get the background color of the current Axes object.
-            The result is a colormap index corresponding to the color.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>rect=xget("clipping")</term>
-        <listitem>
-          <para>Get the clipping zone as a rectangle rect=[x,y,w,h]
-            (Upper-Left point Width Height).
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>c=xget("color")</term>
-        <listitem>
-          <para>Get the default color for filling, line or text drawing
-            functions. <literal>c</literal> is an integer projected in the
-            interval [0,whiteid]. 0 stands for black filling and whiteid for
-            white. The value of whiteid can be obtained with
-            <literal>xget("white")</literal>.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>cmap=xget("colormap")</term>
-        <listitem>
-          <para>Get the colormap used for the current graphics window as a m x
-            3 RGB matrix.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>dash=xget("dashes")</term>
-        <listitem>
-          <para>Get the dash style dash=[dash_number] where dash_number is the
-            id of the dash. This keyword is obsolete, please use
-            <literal>xget("color")</literal> or <literal>xget("line
-              style")
-            </literal>
-            instead.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>font=xget("font")</term>
-        <listitem>
-          <para>Get font=[fontid,fontsize], the default font and the default
-            size for fonts. size.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>fontsize=xget("font size")</term>
-        <listitem>
-          <para>Get the default size for fonts size.</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>color=xget("foreground")</term>
-        <listitem>
-          <para>Get the foreground color of the current Axes object.
-            The result is a colormap index corresponding to the color.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>str=xget("fpf")</term>
-        <listitem>
-          <para>Get the floating point format for number display in contour
-            functions. Note that <literal>str</literal> is <literal>""</literal>
-            when default format is used.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>color=xget("hidden3d")</term>
-        <listitem>
-          <para>Get the color number for hidden faces in plot3d.</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>pat=xget("lastpattern")</term>
-        <listitem>
-          <para>Get the id of the last available pattern or color, with the
-            current colormap of the current window. In fact
-            <literal>pat+1</literal> and <literal>pat+2</literal> are also
-            available and stand respectively for black and white pattern.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>type=xget("line mode")</term>
-        <listitem>
-          <para>Get the line drawing mode. type=1 is absolute mode and type=0
-            is relative mode. (Warning: the mode type=0 is has bugs)
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xget("line style")</term>
-        <listitem>
-          <para>Get the default line style (1: solid, &gt;1 for dashed
-            lines).
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>mark=xget("mark")</term>
-        <listitem>
-          <para>Get the default mark id and the default marks size.
-            <literal>mark=[markid,marksize]</literal>.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>marksize=xget("mark size")</term>
-        <listitem>
-          <para>Get the default marks size.</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>pat=xget("pattern")</term>
-        <listitem>
-          <para>Get the current pattern or the current color.
-            <literal>pat</literal> is an integer in the range
-            <literal>[1,last]</literal>. When one uses black and white, 0 is
-            used for black filling and <literal>last</literal> for white. The
-            value of <literal>last</literal> can be obtained with
-            <literal>xget("lastpattern")</literal>.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>value=xget("thickness")</term>
-        <listitem>
-          <para>Get the thickness of lines in pixel (0 and 1 have the same
-            meaning: 1 pixel thick).
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>flag=xget("use color")</term>
-        <listitem>
-          <para>Get the flag 0 (use black and white) or 1 (use colors). See
-            <literal>xset</literal>.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>[x,y]=xget("viewport")</term>
-        <listitem>
-          <para>Get the current postion of the visible part of graphics in the
-            panner.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>dim=xget("wdim")</term>
-        <listitem>
-          <para>Get the width and the height of the current graphics window
-            dim=[width,height].
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>win=xget("window")</term>
-        <listitem>
-          <para>
-            Get the current window number <literal>win</literal>.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>pos=xget("wpos");</term>
-        <listitem>
-          <para>Get the position of the upper left point of the graphics
-            window pos=[x,y].
-          </para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
-  </refsection>
-  <refsection role="see also">
-    <title>See Also</title>
-    <simplelist type="inline">
-      <member>
-        <link linkend="xset">xset</link>
-      </member>
-      <member>
-        <link linkend="getcolor">getcolor</link>
-      </member>
-      <member>
-        <link linkend="getsymbol">getsymbol</link>
-      </member>
-      <member>
-        <link linkend="ged">ged</link>
-      </member>
-      <member>
-        <link linkend="set">set</link>
-      </member>
-      <member>
-        <link linkend="graphics_entities">graphics_entities</link>
-      </member>
-    </simplelist>
-  </refsection>
-  <refsection>
-    <title>History</title>
-    <revhistory>
-      <revision>
-        <revnumber>5.4.0</revnumber>
-        <revremark>
-          The "alufunction" property is no more supported, this property was no more used for rendering since Scilab 5.0.1.
-        </revremark>
-      </revision>
-    </revhistory>
-  </refsection>
+    <refnamediv>
+        <refname>xget</refname>
+        <refpurpose>
+            get current values of the graphics context. <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>[x1]=xget(str,[flag])
+            xget()
+        </synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Arguments</title>
+        <variablelist>
+            <varlistentry>
+                <term>str</term>
+                <listitem>
+                    <para>string.</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>flag</term>
+                <listitem>
+                    <para>optional. Set to 1 gives a verbose mode.</para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
+        <title>Description</title>
+        <para>
+            <emphasis role="bold">Warning this function is obsolete</emphasis>.
+            Use the Scilab graphic objetcs representation instead (see the <link linkend="set">set</link> and <link linkend="get">get</link> functions as
+            well as the <link linkend="graphics_entities">graphics_entities</link>
+            help page).
+        </para>
+        <para>This function is used to get values from the graphics context on the
+            topic specified by the string <literal>str</literal>. When called with no
+            argument, a choice menu is created showing the current values and changes
+            can be performed through toggle buttons.
+        </para>
+        <variablelist>
+            <varlistentry>
+                <term>str=xget("auto clear")</term>
+                <listitem>
+                    <para>
+                        Get the auto clear status (<literal>"on"</literal> or
+                        <literal>"off"</literal>).
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>color=xget("background")</term>
+                <listitem>
+                    <para>Get the background color of the current Axes object.
+                        The result is a colormap index corresponding to the color.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>rect=xget("clipping")</term>
+                <listitem>
+                    <para>Get the clipping zone as a rectangle rect=[x,y,w,h]
+                        (Upper-Left point Width Height).
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>c=xget("color")</term>
+                <listitem>
+                    <para>Get the default color for filling, line or text drawing
+                        functions. <literal>c</literal> is an integer projected in the
+                        interval [0,whiteid]. 0 stands for black filling and whiteid for
+                        white. The value of whiteid can be obtained with
+                        <literal>xget("white")</literal>.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>cmap=xget("colormap")</term>
+                <listitem>
+                    <para>Get the colormap used for the current graphics window as a m x
+                        3 RGB matrix.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>dash=xget("dashes")</term>
+                <listitem>
+                    <para>Get the dash style dash=[dash_number] where dash_number is the
+                        id of the dash. This keyword is obsolete, please use
+                        <literal>xget("color")</literal> or <literal>xget("line
+                            style")
+                        </literal>
+                        instead.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>font=xget("font")</term>
+                <listitem>
+                    <para>Get font=[fontid,fontsize], the default font and the default
+                        size for fonts. size.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>fontsize=xget("font size")</term>
+                <listitem>
+                    <para>Get the default size for fonts size.</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>color=xget("foreground")</term>
+                <listitem>
+                    <para>Get the foreground color of the current Axes object.
+                        The result is a colormap index corresponding to the color.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>str=xget("fpf")</term>
+                <listitem>
+                    <para>Get the floating point format for number display in contour
+                        functions. Note that <literal>str</literal> is <literal>""</literal>
+                        when default format is used.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>color=xget("hidden3d")</term>
+                <listitem>
+                    <para>Get the color number for hidden faces in plot3d.</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>pat=xget("lastpattern")</term>
+                <listitem>
+                    <para>Get the id of the last available pattern or color, with the
+                        current colormap of the current window. In fact
+                        <literal>pat+1</literal> and <literal>pat+2</literal> are also
+                        available and stand respectively for black and white pattern.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>type=xget("line mode")</term>
+                <listitem>
+                    <para>Get the line drawing mode. type=1 is absolute mode and type=0
+                        is relative mode. (Warning: the mode type=0 is has bugs)
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xget("line style")</term>
+                <listitem>
+                    <para>Get the default line style (1: solid, &gt;1 for dashed
+                        lines).
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>mark=xget("mark")</term>
+                <listitem>
+                    <para>Get the default mark id and the default marks size.
+                        <literal>mark=[markid,marksize]</literal>.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>marksize=xget("mark size")</term>
+                <listitem>
+                    <para>Get the default marks size.</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>pat=xget("pattern")</term>
+                <listitem>
+                    <para>Get the current pattern or the current color.
+                        <literal>pat</literal> is an integer in the range
+                        <literal>[1,last]</literal>. When one uses black and white, 0 is
+                        used for black filling and <literal>last</literal> for white. The
+                        value of <literal>last</literal> can be obtained with
+                        <literal>xget("lastpattern")</literal>.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>value=xget("thickness")</term>
+                <listitem>
+                    <para>Get the thickness of lines in pixel (0 and 1 have the same
+                        meaning: 1 pixel thick).
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>flag=xget("use color")</term>
+                <listitem>
+                    <para>Get the flag 0 (use black and white) or 1 (use colors). See
+                        <literal>xset</literal>.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>[x,y]=xget("viewport")</term>
+                <listitem>
+                    <para>Get the current postion of the visible part of graphics in the
+                        panner.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>dim=xget("wdim")</term>
+                <listitem>
+                    <para>Get the width and the height of the current graphics window
+                        dim=[width,height].
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>win=xget("window")</term>
+                <listitem>
+                    <para>
+                        Get the current window number <literal>win</literal>.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>pos=xget("wpos");</term>
+                <listitem>
+                    <para>Get the position of the upper left point of the graphics
+                        window pos=[x,y].
+                    </para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="xset">xset</link>
+            </member>
+            <member>
+                <link linkend="getcolor">getcolor</link>
+            </member>
+            <member>
+                <link linkend="getsymbol">getsymbol</link>
+            </member>
+            <member>
+                <link linkend="ged">ged</link>
+            </member>
+            <member>
+                <link linkend="set">set</link>
+            </member>
+            <member>
+                <link linkend="graphics_entities">graphics_entities</link>
+            </member>
+        </simplelist>
+    </refsection>
+    <refsection>
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.4.0</revnumber>
+                <revremark>
+                    The "alufunction" property is no more supported, this property was no more used for rendering since Scilab 5.0.1.
+                </revremark>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>
index 5898f22..e9f2c1a 100644 (file)
  *
  -->
 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="xset">
-  <refnamediv>
-    <refname>xset</refname>
-    <refpurpose>
-      set values of the graphics context.<emphasis role="bold">This function is obsolete.</emphasis>
-    </refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>xset(choice-name,x1,x2,x3,x4,x5)
-      xset()
-    </synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Arguments</title>
-    <variablelist>
-      <varlistentry>
-        <term>choice-name</term>
-        <listitem>
-          <para>string</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>x1,...,x5</term>
-        <listitem>
-          <para>
-            depending on <literal>choice-name</literal>
-          </para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
-  </refsection>
-  <refsection>
-    <title>Description</title>
-    <para>
-      <emphasis role="bold">Warning this function is obsolete.</emphasis>
-      Use the Scilab graphic objects representation
-      instead (see the
-      <link linkend="set">set</link> and <link linkend="get">get</link>
-      functions as well as the <link linkend="graphics_entities">graphics_entities</link> help
-      page).
-    </para>
-    <para>
-      <literal>xset</literal> is used to set default values of the current window
-      graphic context.
-    </para>
-    <para>When called no argument, a choice menu is created showing the current
-      values and changes can be performed through toggle buttons.
-    </para>
-    <para>
-      Use <literal>xset()</literal> to display or set the current color, mark and
-      fonts used.
-    </para>
-    <para/>
-    <variablelist>
-      <varlistentry>
-        <term>xset("auto clear","on"|"off")</term>
-        <listitem>
-          <para>Switch "on" or "off" the auto clear mode for graphics. When the
-            auto clear mode is "on", successive plots are not superposed, ie a
-            <literal>clf()</literal> operation (the graphics window is cleared and the
-            associated recorded graphics is erased) is performed before each high
-            level graphics function. Default value is "off".
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("background",color)</term>
-        <listitem>
-          <para>Set the background color of the current Axes object.
-            The <literal>color</literal> argument is the colormap index of the color to use.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("clipping",x,y,w,h)</term>
-        <listitem>
-          <para>Set the clipping zone (the zone of the graphics window where
-            plots can be drawn) to the rectangle (x,y,w,h) (Upper-Left point Width
-            Height). This function uses the current coordinates of the plot.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("color",value)</term>
-        <listitem>
-          <para>Set the default color for filling, line or text drawing
-            functions. <literal>value</literal> is an integer projected in the interval
-            [0,whiteid]. 0 is used for black filling and whiteid for white. The
-            value of whiteid can be obtained with <literal>xget("white")</literal>.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("colormap",cmap)</term>
-        <listitem>
-          <para>Set the colormap as a m x 3 matrix. m is the number of colors.
-            Color number i is given as a 3-uple cmap(i,1), cmap(i,2), cmap(i,3)
-            corresponding respectively to red, green and blue intensity between 0
-            and 1.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("dashes",i)</term>
-        <listitem>
-          <para>
-            In black and white mode (<literal>xset("use color",0)</literal>), set
-            the dash style to style i (0 for solid line). In color mode
-            (<literal>xset("use color",1 )</literal>) this is used to set line, mark and
-            text color. This keyword is obsolete, please use
-            <literal>xset('color',i)</literal> or <literal>xset('line style',i)</literal>
-            instead.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <listitem>
-          <para>Reset the graphics context to default values.</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("font",fontid,fontsize) : Set the current font and its current</term>
-        <listitem>
-          <para>
-            size. Note that <literal>fontsize</literal> applies to all fonts not
-            only <literal>fontid</literal> .
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("font size",fontsize)</term>
-        <listitem>
-          <para>Set the fonts size.</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("foreground",color)</term>
-        <listitem>
-          <para>Set the foreground color of the current Axes object.
-            The <literal>color</literal> argument is the colormap index of the color to use.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("fpf",string)</term>
-        <listitem>
-          <para>Set the floating point format for number display in contour
-            functions. <literal>string</literal> is a string giving the format in C
-            format syntax (for example <literal>string="%.3f"</literal>). Use
-            <literal>string=""</literal> to switch back to default format.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("hidden3d",colorid) : Set the color number for backward facing faces in</term>
-        <listitem>
-          <para>
-            <literal>plot3d</literal>. <literal>colorid=0</literal> zero suppress the
-            drawing of backward facing faces of 3d objects. This is technically
-            called 'culling' and speeds up the rendering of closed surfaces.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("line mode",type)</term>
-        <listitem>
-          <para>This function is used to set the line drawing mode. Absolute
-            mode is set with type=1 and relative mode with type=0. (Warning: the
-            mode type=0 has bugs)
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("line style",value)</term>
-        <listitem>
-          <para>Set the current line style (1: solid, &gt;1 for dashed
-            lines).
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("mark",markid,marksize)</term>
-        <listitem>
-          <para>Set the current mark and the current mark size. Use
-            <literal>xset()</literal> to see the marks. Note that <literal>marksize</literal>
-            applies to all marks not only <literal>markid</literal> .
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("mark size",marksize)</term>
-        <listitem>
-          <para>Set the marks size.</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("pattern",value)</term>
-        <listitem>
-          <para>Set the current pattern for filling functions. value is an
-            integer projected in the interval [0,whiteid]. 0 is used for black
-            filling and whiteid for white. The value of whiteid can be obtained
-            with <literal>xget("white")</literal>. "pattern" is equivalent to
-            "color".
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("pixmap",flag)</term>
-        <listitem>
-          <para>If flag=0 the graphics are directly displayed on the screen. If
-            flag=1 the graphics are done on a pixmap and are sent to the graphics
-            window with the command <literal>xset("wshow")</literal>. The pixmap is
-            cleared with the command <literal>xset("wwpc")</literal>. Note that the
-            usual command <literal>clf()</literal> also clears the pixmap.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("thickness",value)</term>
-        <listitem>
-          <para>Set the thickness of lines in pixel (0 and 1 have the same
-            meaning: 1 pixel thick).
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("use color",flag)</term>
-        <listitem>
-          <para>
-            If flag=1 then <literal>xset("pattern",.)</literal> or
-            <literal>xset("dashes",.)</literal> will be used so as to change the default
-            color for drawing or for filling patterns. If flag=0 then we switch
-            back to the gray and dashes mode.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("viewport",x,y)</term>
-        <listitem>
-          <para>Set the position of the panner.</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("wdim",width,height)</term>
-        <listitem>
-          <para>Set the width and the height of the current graphics window.
-            This option is not used by the postscript driver.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("wpdim",width,height)</term>
-        <listitem>
-          <para>Sets the width and the height of the current physical graphic
-            window (which can be different from the actual size in mode wresize
-            1). This option is not used by the postscript driver.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("window",window-number)</term>
-        <listitem>
-          <para>
-            Set the current window to the window <literal>window-number</literal>
-            and creates the window if it does not exist.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("wpos",x,y)</term>
-        <listitem>
-          <para>Set the position of the upper left point of the graphics
-            window.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("wresize",flag)</term>
-        <listitem>
-          <para>If flag=1 then the graphic is automatically resized to fill the
-            graphics window.
-          </para>
-          <programlisting role=""><![CDATA[
+    <refnamediv>
+        <refname>xset</refname>
+        <refpurpose>
+            set values of the graphics context.<emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>xset(choice-name,x1,x2,x3,x4,x5)
+            xset()
+        </synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Arguments</title>
+        <variablelist>
+            <varlistentry>
+                <term>choice-name</term>
+                <listitem>
+                    <para>string</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>x1,...,x5</term>
+                <listitem>
+                    <para>
+                        depending on <literal>choice-name</literal>
+                    </para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
+        <title>Description</title>
+        <para>
+            <emphasis role="bold">Warning this function is obsolete.</emphasis>
+            Use the Scilab graphic objects representation
+            instead (see the
+            <link linkend="set">set</link> and <link linkend="get">get</link>
+            functions as well as the <link linkend="graphics_entities">graphics_entities</link> help
+            page).
+        </para>
+        <para>
+            <literal>xset</literal> is used to set default values of the current window
+            graphic context.
+        </para>
+        <para>When called no argument, a choice menu is created showing the current
+            values and changes can be performed through toggle buttons.
+        </para>
+        <para>
+            Use <literal>xset()</literal> to display or set the current color, mark and
+            fonts used.
+        </para>
+        <para/>
+        <variablelist>
+            <varlistentry>
+                <term>xset("auto clear","on"|"off")</term>
+                <listitem>
+                    <para>Switch "on" or "off" the auto clear mode for graphics. When the
+                        auto clear mode is "on", successive plots are not superposed, ie a
+                        <literal>clf()</literal> operation (the graphics window is cleared and the
+                        associated recorded graphics is erased) is performed before each high
+                        level graphics function. Default value is "off".
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("background",color)</term>
+                <listitem>
+                    <para>Set the background color of the current Axes object.
+                        The <literal>color</literal> argument is the colormap index of the color to use.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("clipping",x,y,w,h)</term>
+                <listitem>
+                    <para>Set the clipping zone (the zone of the graphics window where
+                        plots can be drawn) to the rectangle (x,y,w,h) (Upper-Left point Width
+                        Height). This function uses the current coordinates of the plot.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("color",value)</term>
+                <listitem>
+                    <para>Set the default color for filling, line or text drawing
+                        functions. <literal>value</literal> is an integer projected in the interval
+                        [0,whiteid]. 0 is used for black filling and whiteid for white. The
+                        value of whiteid can be obtained with <literal>xget("white")</literal>.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("colormap",cmap)</term>
+                <listitem>
+                    <para>Set the colormap as a m x 3 matrix. m is the number of colors.
+                        Color number i is given as a 3-uple cmap(i,1), cmap(i,2), cmap(i,3)
+                        corresponding respectively to red, green and blue intensity between 0
+                        and 1.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("dashes",i)</term>
+                <listitem>
+                    <para>
+                        In black and white mode (<literal>xset("use color",0)</literal>), set
+                        the dash style to style i (0 for solid line). In color mode
+                        (<literal>xset("use color",1 )</literal>) this is used to set line, mark and
+                        text color. This keyword is obsolete, please use
+                        <literal>xset('color',i)</literal> or <literal>xset('line style',i)</literal>
+                        instead.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <listitem>
+                    <para>Reset the graphics context to default values.</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("font",fontid,fontsize) : Set the current font and its current</term>
+                <listitem>
+                    <para>
+                        size. Note that <literal>fontsize</literal> applies to all fonts not
+                        only <literal>fontid</literal> .
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("font size",fontsize)</term>
+                <listitem>
+                    <para>Set the fonts size.</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("foreground",color)</term>
+                <listitem>
+                    <para>Set the foreground color of the current Axes object.
+                        The <literal>color</literal> argument is the colormap index of the color to use.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("fpf",string)</term>
+                <listitem>
+                    <para>Set the floating point format for number display in contour
+                        functions. <literal>string</literal> is a string giving the format in C
+                        format syntax (for example <literal>string="%.3f"</literal>). Use
+                        <literal>string=""</literal> to switch back to default format.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("hidden3d",colorid) : Set the color number for backward facing faces in</term>
+                <listitem>
+                    <para>
+                        <literal>plot3d</literal>. <literal>colorid=0</literal> zero suppress the
+                        drawing of backward facing faces of 3d objects. This is technically
+                        called 'culling' and speeds up the rendering of closed surfaces.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("line mode",type)</term>
+                <listitem>
+                    <para>This function is used to set the line drawing mode. Absolute
+                        mode is set with type=1 and relative mode with type=0. (Warning: the
+                        mode type=0 has bugs)
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("line style",value)</term>
+                <listitem>
+                    <para>Set the current line style (1: solid, &gt;1 for dashed
+                        lines).
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("mark",markid,marksize)</term>
+                <listitem>
+                    <para>Set the current mark and the current mark size. Use
+                        <literal>xset()</literal> to see the marks. Note that <literal>marksize</literal>
+                        applies to all marks not only <literal>markid</literal> .
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("mark size",marksize)</term>
+                <listitem>
+                    <para>Set the marks size.</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("pattern",value)</term>
+                <listitem>
+                    <para>Set the current pattern for filling functions. value is an
+                        integer projected in the interval [0,whiteid]. 0 is used for black
+                        filling and whiteid for white. The value of whiteid can be obtained
+                        with <literal>xget("white")</literal>. "pattern" is equivalent to
+                        "color".
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("pixmap",flag)</term>
+                <listitem>
+                    <para>If flag=0 the graphics are directly displayed on the screen. If
+                        flag=1 the graphics are done on a pixmap and are sent to the graphics
+                        window with the command <literal>xset("wshow")</literal>. The pixmap is
+                        cleared with the command <literal>xset("wwpc")</literal>. Note that the
+                        usual command <literal>clf()</literal> also clears the pixmap.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("thickness",value)</term>
+                <listitem>
+                    <para>Set the thickness of lines in pixel (0 and 1 have the same
+                        meaning: 1 pixel thick).
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("use color",flag)</term>
+                <listitem>
+                    <para>
+                        If flag=1 then <literal>xset("pattern",.)</literal> or
+                        <literal>xset("dashes",.)</literal> will be used so as to change the default
+                        color for drawing or for filling patterns. If flag=0 then we switch
+                        back to the gray and dashes mode.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("viewport",x,y)</term>
+                <listitem>
+                    <para>Set the position of the panner.</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("wdim",width,height)</term>
+                <listitem>
+                    <para>Set the width and the height of the current graphics window.
+                        This option is not used by the postscript driver.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("wpdim",width,height)</term>
+                <listitem>
+                    <para>Sets the width and the height of the current physical graphic
+                        window (which can be different from the actual size in mode wresize
+                        1). This option is not used by the postscript driver.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("window",window-number)</term>
+                <listitem>
+                    <para>
+                        Set the current window to the window <literal>window-number</literal>
+                        and creates the window if it does not exist.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("wpos",x,y)</term>
+                <listitem>
+                    <para>Set the position of the upper left point of the graphics
+                        window.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("wresize",flag)</term>
+                <listitem>
+                    <para>If flag=1 then the graphic is automatically resized to fill the
+                        graphics window.
+                    </para>
+                    <programlisting role=""><![CDATA[
 xdel();
 xset("wresize",1);
 plot2d();
 xset("wdim",1000,500)
  ]]></programlisting>
-          <para>If flag=0 the scale of the graphic is left unchanged when the
-            graphics window is resized. Top left panner or keyboard arrows may be
-            used to scroll over the graphic.
-          </para>
-          <programlisting role=""><![CDATA[
+                    <para>If flag=0 the scale of the graphic is left unchanged when the
+                        graphics window is resized. Top left panner or keyboard arrows may be
+                        used to scroll over the graphic.
+                    </para>
+                    <programlisting role=""><![CDATA[
 xdel();
 plot2d();
 xset("wresize",0);
 xset("wdim",1000,500)
  ]]></programlisting>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("wshow")</term>
-        <listitem>
-          <para>
-            See <literal>xset("pixmap",1)</literal> above.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xset("wwpc")</term>
-        <listitem>
-          <para>
-            See <literal>xset("pixmap",1)</literal> above.
-          </para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
-  </refsection>
-  <refsection role="see also">
-    <title>See Also</title>
-    <simplelist type="inline">
-      <member>
-        <link linkend="xget">xget</link>
-      </member>
-      <member>
-        <link linkend="getcolor">getcolor</link>
-      </member>
-      <member>
-        <link linkend="getsymbol">getsymbol</link>
-      </member>
-      <member>
-        <link linkend="ged">ged</link>
-      </member>
-      <member>
-        <link linkend="set">set</link>
-      </member>
-      <member>
-        <link linkend="graphics_entities">graphics_entities</link>
-      </member>
-    </simplelist>
-  </refsection>
-  <refsection>
-    <title>History</title>
-    <revhistory>
-      <revision>
-        <revnumber>5.4.0</revnumber>
-        <revremark>
-          The "alufunction" property is no more supported, this property was no more used for rendering since Scilab 5.0.1.
-        </revremark>
-      </revision>
-    </revhistory>
-  </refsection>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("wshow")</term>
+                <listitem>
+                    <para>
+                        See <literal>xset("pixmap",1)</literal> above.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xset("wwpc")</term>
+                <listitem>
+                    <para>
+                        See <literal>xset("pixmap",1)</literal> above.
+                    </para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="xget">xget</link>
+            </member>
+            <member>
+                <link linkend="getcolor">getcolor</link>
+            </member>
+            <member>
+                <link linkend="getsymbol">getsymbol</link>
+            </member>
+            <member>
+                <link linkend="ged">ged</link>
+            </member>
+            <member>
+                <link linkend="set">set</link>
+            </member>
+            <member>
+                <link linkend="graphics_entities">graphics_entities</link>
+            </member>
+        </simplelist>
+    </refsection>
+    <refsection>
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.4.0</revnumber>
+                <revremark>
+                    The "alufunction" property is no more supported, this property was no more used for rendering since Scilab 5.0.1.
+                </revremark>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>
index 20cc9cb..d2a0cc2 100644 (file)
  *
  -->
 <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" version="5.0-subset Scilab" xml:id="xsetm" xml:lang="en">
-  <refnamediv>
-    <refname>xsetm</refname>
-    <refpurpose>
-      dialog to set values of the graphics context. <emphasis role="bold">Obsolete function.</emphasis>
-    </refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>xsetm()</synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Description</title>
-    <para>
-      This function as well as the <link linkend="xset">xset</link> one
-      was strongly linked with the old graphic mode which is no more available.
-      The current graphic is much more flexible with respect to parameter
-      setting (see the <link linkend="set">set</link> and <link linkend="get">get</link> functions as well as the <link linkend="graphics_entities">graphics_entities</link> help page). It is
-      possible to start a more convenient property editor using <link linkend="ged">ged</link>.
-    </para>
-  </refsection>
-  <refsection role="see also">
-    <title>See Also</title>
-    <simplelist type="inline">
-      <member>
-        <link linkend="xset">xset</link>
-      </member>
-      <member>
-        <link linkend="ged">ged</link>
-      </member>
-      <member>
-        <link linkend="set">set</link>
-      </member>
-      <member>
-        <link linkend="graphics_entities">graphics_entities</link>
-      </member>
-    </simplelist>
-  </refsection>
+    <refnamediv>
+        <refname>xsetm</refname>
+        <refpurpose>
+            dialog to set values of the graphics context. <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>xsetm()</synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Description</title>
+        <para>
+            This function as well as the <link linkend="xset">xset</link> one
+            was strongly linked with the old graphic mode which is no more available.
+            The current graphic is much more flexible with respect to parameter
+            setting (see the <link linkend="set">set</link> and <link linkend="get">get</link> functions as well as the <link linkend="graphics_entities">graphics_entities</link> help page). It is
+            possible to start a more convenient property editor using <link linkend="ged">ged</link>.
+        </para>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="xset">xset</link>
+            </member>
+            <member>
+                <link linkend="ged">ged</link>
+            </member>
+            <member>
+                <link linkend="set">set</link>
+            </member>
+            <member>
+                <link linkend="graphics_entities">graphics_entities</link>
+            </member>
+        </simplelist>
+    </refsection>
 </refentry>
index 16951b2..b218164 100644 (file)
  *
  -->
 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="gschur">
-  <refnamediv>
-    <refname>gschur</refname>
-    <refpurpose> generalized Schur form (obsolete).  </refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>[As,Es]=gschur(A,E)
-      [As,Es,Q,Z]=gschur(A,E)
-      [As,Es,Z,dim] = gschur(A,E,flag)
-      [As,Es,Z,dim]= gschur(A,E,extern)
-    </synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Description</title>
-    <para>
-      This function is obsolete and is now included in the <literal>schur</literal>
-      function. In most cases the <literal>gschur</literal> function will still work as
-      before, but it will be removed in the future release. 
-    </para>
-    <para>
-      The first three syntaxes can be replaced by
-    </para>
-    <programlisting role=""><![CDATA[ 
+    <refnamediv>
+        <refname>gschur</refname>
+        <refpurpose>
+            generalized Schur form. <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>[As,Es]=gschur(A,E)
+            [As,Es,Q,Z]=gschur(A,E)
+            [As,Es,Z,dim] = gschur(A,E,flag)
+            [As,Es,Z,dim]= gschur(A,E,extern)
+        </synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Description</title>
+        <para>
+            This function is obsolete and is now included in the <literal>schur</literal>
+            function. In most cases the <literal>gschur</literal> function will still work as
+            before, but it will be removed in the future release. 
+        </para>
+        <para>
+            The first three syntaxes can be replaced by
+        </para>
+        <programlisting role=""><![CDATA[ 
 [As,Es]=schur(A,E)
 [As,Es,Q,Z]=schur(A,E);Q=Q' //NOTE THE TRANPOSITION HERE
 [As,Es,Z,dim] = schur(A,E,flag) 
  ]]></programlisting>
-    <para>
-      The last syntax requires little more adaptations:
-    </para>
-    <variablelist>
-      <varlistentry>
-        <term>if</term>
-        <listitem>
-          <para>extern is a scilab function  the new calling sequence
-            should be <literal>[As,Es,Z,dim]= schur(A,E,Nextern)</literal> with
-            Nextern defined as follow:
-          </para>
-          <programlisting role=""><![CDATA[ 
+        <para>
+            The last syntax requires little more adaptations:
+        </para>
+        <variablelist>
+            <varlistentry>
+                <term>if</term>
+                <listitem>
+                    <para>extern is a scilab function  the new calling sequence
+                        should be <literal>[As,Es,Z,dim]= schur(A,E,Nextern)</literal> with
+                        Nextern defined as follow:
+                    </para>
+                    <programlisting role=""><![CDATA[ 
 function t=Nextern(R)
 if R(2)==0 then
   t=extern([1,R(1),R(3)])==1
@@ -59,18 +61,18 @@ else
 end
 endfunction
  ]]></programlisting>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>if</term>
-        <listitem>
-          <para>extern is the name of an external function coded in Fortran or C
-            the new calling sequence should be <literal>[As,Es,Z,dim]=    schur(A,E,'nextern')</literal> with nextern defined as follow:
-          </para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
-    <programlisting role=""><![CDATA[ 
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>if</term>
+                <listitem>
+                    <para>extern is the name of an external function coded in Fortran or C
+                        the new calling sequence should be <literal>[As,Es,Z,dim]=    schur(A,E,'nextern')</literal> with nextern defined as follow:
+                    </para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+        <programlisting role=""><![CDATA[ 
 logical function nextern(ar,ai,beta)
 double precision ar,ai,beta
 integer r,extern
@@ -82,16 +84,16 @@ endif
 nextern=r.eq.1
 end
  ]]></programlisting>
-  </refsection>
-  <refsection role="see also">
-    <title>See Also</title>
-    <simplelist type="inline">
-      <member>
-        <link linkend="external">external</link>
-      </member>
-      <member>
-        <link linkend="schur">schur</link>
-      </member>
-    </simplelist>
-  </refsection>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="external">external</link>
+            </member>
+            <member>
+                <link linkend="schur">schur</link>
+            </member>
+        </simplelist>
+    </refsection>
 </refentry>
index 1b664a7..dbde0cb 100644 (file)
  *
  -->
 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="gspec">
-  <refnamediv>
-    <refname>gspec</refname>
-    <refpurpose> eigenvalues of matrix pencil (obsolete)  </refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>[al,be]=gspec(A,E)
-      [al,be,Z]=gspec(A,E)
-    </synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Description</title>
-    <para>
-      This function is now included in the <literal>spec</literal> function.
-      the calling syntax must be replaced by
-    </para>
-    <programlisting role=""><![CDATA[ 
+    <refnamediv>
+        <refname>gspec</refname>
+        <refpurpose>
+            eigenvalues of matrix pencil. <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>[al,be]=gspec(A,E)
+            [al,be,Z]=gspec(A,E)
+        </synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Description</title>
+        <para>
+            This function is now included in the <literal>spec</literal> function.
+            the calling syntax must be replaced by
+        </para>
+        <programlisting role=""><![CDATA[ 
 [al,be]=spec(A,E)
 [al,be,Z]=spec(A,E)
  ]]></programlisting>
-  </refsection>
-  <refsection role="see also">
-    <title>See Also</title>
-    <simplelist type="inline">
-      <member>
-        <link linkend="spec">spec</link>
-      </member>
-    </simplelist>
-  </refsection>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="spec">spec</link>
+            </member>
+        </simplelist>
+    </refsection>
 </refentry>
index b8b2d74..8f9f8bf 100644 (file)
  *
  -->
 <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" version="5.0-subset Scilab" xml:id="code2str" xml:lang="en">
-  <refnamediv>
-    <refname>code2str</refname>
-    <refpurpose>returns character string associated with Scilab integer
-      codes. <emphasis role="bold">This function is obsolete.</emphasis>
-    </refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>str=code2str(c)</synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Arguments</title>
-    <variablelist>
-      <varlistentry>
-        <term>str</term>
-        <listitem>
-          <para>A character string</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>c</term>
-        <listitem>
-          <para>vector of character integer codes</para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
-  </refsection>
-  <refsection>
-    <title>Description</title>
-    <para>Returns character string associated with Scilab integer codes.str is
-      such that c(i) is the Scilab integer code of part(str,i))
-    </para>
-  </refsection>
-  <refsection>
-    <title>Examples</title>
-    <programlisting role="example"><![CDATA[ 
+    <refnamediv>
+        <refname>code2str</refname>
+        <refpurpose>returns character string associated with Scilab integer
+            codes. <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>str=code2str(c)</synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Arguments</title>
+        <variablelist>
+            <varlistentry>
+                <term>str</term>
+                <listitem>
+                    <para>A character string</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>c</term>
+                <listitem>
+                    <para>vector of character integer codes</para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
+        <title>Description</title>
+        <para>Returns character string associated with Scilab integer codes.str is
+            such that c(i) is the Scilab integer code of part(str,i))
+        </para>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
+        <programlisting role="example"><![CDATA[ 
 code2str([-28 12 18 21 10 11])
 str2code('Scilab')' 
  ]]></programlisting>
-  </refsection>
-  <refsection role="see also">
-    <title>See Also</title>
-    <simplelist type="inline">
-      <member>
-        <link linkend="str2code">str2code</link>
-      </member>
-      <member>
-        <link linkend="ascii">ascii</link>
-      </member>
-    </simplelist>
-  </refsection>
-  <refsection>
-    <title>History</title>
-    <revhistory>
-      <revision>
-        <revnumber>5.4.0</revnumber>
-        <revremark>This function will be removed in Scilab 5.4.1</revremark>
-      </revision>
-    </revhistory>
-  </refsection>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="str2code">str2code</link>
+            </member>
+            <member>
+                <link linkend="ascii">ascii</link>
+            </member>
+        </simplelist>
+    </refsection>
+    <refsection>
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.4.0</revnumber>
+                <revremark>This function will be removed in Scilab 5.4.1</revremark>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>
index ca0dc81..ca50384 100644 (file)
  *
  -->
 <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" version="5.0-subset Scilab" xml:id="str2code" xml:lang="en">
-  <refnamediv>
-    <refname>str2code</refname>
-    <refpurpose>return scilab integer codes associated with a character
-      string. <emphasis role="bold">This function is obsolete.</emphasis>
-    </refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>c=str2code(str)</synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Arguments</title>
-    <variablelist>
-      <varlistentry>
-        <term>str</term>
-        <listitem>
-          <para>A character string.</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>c</term>
-        <listitem>
-          <para>A vector of character integer codes</para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
-  </refsection>
-  <refsection>
-    <title>Description</title>
-    <para>Return c such that c(i) is the scilab integer code of
-      part(str,i))
-    </para>
-  </refsection>
-  <refsection>
-    <title>Examples</title>
-    <programlisting role="example"><![CDATA[ 
+    <refnamediv>
+        <refname>str2code</refname>
+        <refpurpose>return scilab integer codes associated with a character
+            string. <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>c=str2code(str)</synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Arguments</title>
+        <variablelist>
+            <varlistentry>
+                <term>str</term>
+                <listitem>
+                    <para>A character string.</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>c</term>
+                <listitem>
+                    <para>A vector of character integer codes</para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
+        <title>Description</title>
+        <para>Return c such that c(i) is the scilab integer code of
+            part(str,i))
+        </para>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
+        <programlisting role="example"><![CDATA[ 
 str2code('Scilab')'
 code2str([-28 12 18 21 10 11])
  ]]></programlisting>
-  </refsection>
-  <refsection role="see also">
-    <title>See Also</title>
-    <simplelist type="inline">
-      <member>
-        <link linkend="code2str">code2str</link>
-      </member>
-      <member>
-        <link linkend="ascii">ascii</link>
-      </member>
-    </simplelist>
-  </refsection>
-  <refsection>
-    <title>History</title>
-    <revhistory>
-      <revision>
-        <revnumber>5.4.0</revnumber>
-        <revremark>This function will be removed in Scilab 5.4.1</revremark>
-      </revision>
-    </revhistory>
-  </refsection>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="code2str">code2str</link>
+            </member>
+            <member>
+                <link linkend="ascii">ascii</link>
+            </member>
+        </simplelist>
+    </refsection>
+    <refsection>
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.4.0</revnumber>
+                <revremark>This function will be removed in Scilab 5.4.1</revremark>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>
index 110c57c..3cfa1f4 100644 (file)
@@ -1,91 +1,93 @@
 <?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" version="5.0-subset Scilab" xml:lang="en" xml:id="rafiter">
-  <refnamediv>
-    <refname>rafiter</refname>
-    <refpurpose> (obsolete) iterative refinement for a s.p.d. linear system  </refpurpose>
-  </refnamediv>
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>[xn, rn] = rafiter(A, C_ptr, b, x0, [, nb_iter, verb])</synopsis>
-  </refsynopsisdiv>
-  <refsection>
-    <title>Arguments</title>
-    <variablelist>
-      <varlistentry>
-        <term>A  </term>
-        <listitem>
-          <para>a real symmetric positive definite sparse matrix</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>C_ptr  </term>
-        <listitem>
-          <para>a pointer to a Cholesky factorization (got with taucs_chfact)</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>b  </term>
-        <listitem>
-          <para>column vector (r.h.s of the linear system) but "matrix" (multiple r.h.s.) are allowed.</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>x0  </term>
-        <listitem>
-          <para>first solution obtained with taucs_chsolve(C_ptr, b)</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>nb_iter  </term>
-        <listitem>
-          <para>(optional) number of raffinement iterations (default 2)</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>verb  </term>
-        <listitem>
-          <para>(optional) boolean, must be %t for displaying the intermediary results, 
-            and %f (default) if you do not want.
-          </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>xn  </term>
-        <listitem>
-          <para>new refined solution</para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>rn  </term>
-        <listitem>
-          <para>
-            residual (<literal>A*xn - b</literal>)
-          </para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
-  </refsection>
-  <refsection>
-    <title>Description</title>
-    <para>
-      This function is somewhat obsolete, use <literal>x = taucs_chsolve(C_ptr,b,A)</literal>
-      (see <link linkend="taucs_chsolve">taucs_chsolve</link>) which do one iterative refinement step.
-    </para>
-    <para>
-      To use if you want to improve a little the solution got with taucs_chsolve.
-      Note that with verb=%t the displayed internal steps are essentially meaningful 
-      in the case where b is a column vector.
-    </para>
-  </refsection>
-  <refsection>
-    <title>Caution</title>
-    <para>
-      Currently there is no verification for the input parameters !
-    </para>
-  </refsection>
-  <refsection>
-    <title>Examples</title>
-    <programlisting role="example"><![CDATA[ 
+    <refnamediv>
+        <refname>rafiter</refname>
+        <refpurpose>
+            Iterative refinement for a s.p.d. linear system. <emphasis role="bold">This function is obsolete.</emphasis>  
+        </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>[xn, rn] = rafiter(A, C_ptr, b, x0, [, nb_iter, verb])</synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Arguments</title>
+        <variablelist>
+            <varlistentry>
+                <term>A  </term>
+                <listitem>
+                    <para>a real symmetric positive definite sparse matrix</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>C_ptr  </term>
+                <listitem>
+                    <para>a pointer to a Cholesky factorization (got with taucs_chfact)</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>b  </term>
+                <listitem>
+                    <para>column vector (r.h.s of the linear system) but "matrix" (multiple r.h.s.) are allowed.</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>x0  </term>
+                <listitem>
+                    <para>first solution obtained with taucs_chsolve(C_ptr, b)</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>nb_iter  </term>
+                <listitem>
+                    <para>(optional) number of raffinement iterations (default 2)</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>verb  </term>
+                <listitem>
+                    <para>(optional) boolean, must be %t for displaying the intermediary results, 
+                        and %f (default) if you do not want.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>xn  </term>
+                <listitem>
+                    <para>new refined solution</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>rn  </term>
+                <listitem>
+                    <para>
+                        residual (<literal>A*xn - b</literal>)
+                    </para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
+        <title>Description</title>
+        <para>
+            This function is somewhat obsolete, use <literal>x = taucs_chsolve(C_ptr,b,A)</literal>
+            (see <link linkend="taucs_chsolve">taucs_chsolve</link>) which do one iterative refinement step.
+        </para>
+        <para>
+            To use if you want to improve a little the solution got with taucs_chsolve.
+            Note that with verb=%t the displayed internal steps are essentially meaningful 
+            in the case where b is a column vector.
+        </para>
+    </refsection>
+    <refsection>
+        <title>Caution</title>
+        <para>
+            Currently there is no verification for the input parameters !
+        </para>
+    </refsection>
+    <refsection>
+        <title>Examples</title>
+        <programlisting role="example"><![CDATA[ 
 [A] = ReadHBSparse(SCI+"/modules/umfpack/examples/bcsstk24.rsa");
 C_ptr = taucs_chfact(A);
 b = rand(size(A,1),1);
@@ -95,16 +97,16 @@ norm(A*x0 - b)
 norm(A*xn - b)
 taucs_chdel(C_ptr)
  ]]></programlisting>
-  </refsection>
-  <refsection role="see also">
-    <title>See Also</title>
-    <simplelist type="inline">
-      <member>
-        <link linkend="taucs_chsolve">taucs_chsolve</link>
-      </member>
-      <member>
-        <link linkend="taucs_chfact">taucs_chfact</link>
-      </member>
-    </simplelist>
-  </refsection>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="taucs_chsolve">taucs_chsolve</link>
+            </member>
+            <member>
+                <link linkend="taucs_chfact">taucs_chfact</link>
+            </member>
+        </simplelist>
+    </refsection>
 </refentry>