Revision of help pages for Matplot and Matplot1 functions. 98/10598/1
Stanislav KROTER [Mon, 25 Feb 2013 04:53:25 +0000 (09:53 +0500)]
Change-Id: I77915afd23fc46373b5620d53b38cf8178ac2da2

scilab/modules/graphics/help/en_US/2d_plot/Matplot.xml
scilab/modules/graphics/help/en_US/2d_plot/Matplot1.xml

index 02d5044..4b2b825 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"  xml:lang="en" xml:id="Matplot">
     <refnamediv>
         <refname>Matplot</refname>
-        <refpurpose>2D plot of a matrix using
-            colors
+        <refpurpose>
+            2D plot of a matrix using colors
         </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>Matplot(a,[strf,rect,nax])
-            Matplot(a,&lt;opt_args&gt;)
+        <synopsis>
+            Matplot(a, [strf, rect, nax])
+            Matplot(a, &lt;opt_args&gt;)
         </synopsis>
     </refsynopsisdiv>
     <refsection>
             <varlistentry>
                 <term>a</term>
                 <listitem>
-                    <para>real matrix of size (n1,n2).</para>
+                    <para>
+                        a real matrix of size (<literal>n1</literal>, <literal>n2</literal>).
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>&lt;opt_args&gt;</term>
                 <listitem>
                     <para>
-                        This represents a sequence of statements <literal>key1=value1,
-                            key2=value2
-                        </literal>
-                        ,... where <literal>key1</literal>,
-                        <literal>key2,...</literal> can be one of the following:
+                        this represents a sequence of statements 
+                        <literal>key1=value1, key2=value2, ...</literal>
+                        where <literal>key1</literal>,
+                        <literal>key2</literal>, ... can be one of the following:
                     </para>
                     <variablelist>
                         <varlistentry>
                             <term>rect</term>
                             <listitem>
-                                <para>sets the bounds of the plot. If this key is given and
-                                    neither <literal>frameflag</literal> nor <literal>strf</literal> is given
-                                    then the <literal>y</literal> character of <literal>strf</literal> is
+                                <para>
+                                    sets the bounds of the plot. If this key is given and
+                                    neither <varname>frameflag</varname> nor <varname>strf</varname> is given
+                                    then the <varname>y</varname> character of <varname>strf</varname> is
                                     supposed to be <literal>7</literal>. See below for value.
                                 </para>
                             </listitem>
                         <varlistentry>
                             <term>nax</term>
                             <listitem>
-                                <para>sets the grids definition. If this key is given and
-                                    neither <literal>axesflag</literal> nor <literal>strf</literal> is given
-                                    then the <literal>z</literal> character of <literal>strf</literal> is
+                                <para>
+                                    sets the grids definition. If this key is given and
+                                    neither <varname>axesflag</varname> nor <varname>strf</varname> is given
+                                    then the <varname>z</varname> character of <varname>strf</varname> is
                                     supposed to be <literal>1</literal>. See below for value.
                                 </para>
                             </listitem>
                         <varlistentry>
                             <term>frameflag</term>
                             <listitem>
-                                <para>specifies how the frame of the plot is computed. The
-                                    value is an integer ranging from 0 to 8. It corresponds to the
-                                    <literal>y</literal> character of <literal>strf</literal>. See below.
+                                <para>
+                                    specifies how the frame of the plot is computed. The
+                                    value is an integer ranging from <literal>0</literal> to
+                                    <literal>8</literal>. It corresponds to the <varname>y</varname>
+                                    character of <varname>strf</varname>. See below.
                                 </para>
                             </listitem>
                         </varlistentry>
                         <varlistentry>
                             <term>axesflag</term>
                             <listitem>
-                                <para>specifies what kind of axes are drawn around the plot.
-                                    The value is an integer ranging from 0 to 5. It corresponds to
-                                    the <literal>z</literal> character of <literal>strf</literal>. See
-                                    below.
+                                <para>
+                                    specifies what kind of axes are drawn around the plot.
+                                    The value is an integer ranging from <literal>0</literal> to
+                                    <literal>5</literal>. It corresponds to the <varname>z</varname>
+                                    character of <varname>strf</varname>. See below.
                                 </para>
                             </listitem>
                         </varlistentry>
                             <term>default</term>
                             <listitem>
                                 <para>
-                                    The default is <literal>"081"</literal>.
+                                    the default is <literal>"081"</literal>.
                                 </para>
                             </listitem>
                         </varlistentry>
                                     <varlistentry>
                                         <term>x=1</term>
                                         <listitem>
-                                            <para>captions are displayed. They are given by the
-                                                optional argument <literal>leg</literal>.
+                                            <para>
+                                                captions are displayed. They are given by the
+                                                optional argument <varname>leg</varname>.
                                             </para>
                                         </listitem>
                                     </varlistentry>
                         <varlistentry>
                             <term>y</term>
                             <listitem>
-                                <para>controls the computation of the actual coordinate ranges
+                                <para>
+                                    controls the computation of the actual coordinate ranges
                                     from the minimal requested values. Actual ranges can be larger
                                     than minimal requirements.
                                 </para>
                                     <varlistentry>
                                         <term>y=0</term>
                                         <listitem>
-                                            <para>no computation, the plot use the previus (or
-                                                default) scale
+                                            <para>
+                                                no computation, the plot use the previous (or
+                                                default) scale.
                                             </para>
                                         </listitem>
                                     </varlistentry>
                                     <varlistentry>
                                         <term>y=1</term>
                                         <listitem>
-                                            <para>from the rect arg</para>
+                                            <para>
+                                                from the <varname>rect</varname> argument.
+                                            </para>
                                         </listitem>
                                     </varlistentry>
                                     <varlistentry>
                                         <term>y=2</term>
                                         <listitem>
-                                            <para>from the min/max of the x, y data</para>
+                                            <para>from the min/max of the x, y data.</para>
                                         </listitem>
                                     </varlistentry>
                                     <varlistentry>
                                         <term>y=3</term>
                                         <listitem>
-                                            <para>built for an isometric scale from the rect
-                                                arg
+                                            <para>
+                                                built for an isometric scale from the
+                                                <varname>rect</varname> argument.
                                             </para>
                                         </listitem>
                                     </varlistentry>
                                         <term>y=4</term>
                                         <listitem>
                                             <para>built for an isometric plot from the min/max of
-                                                the x, y data
+                                                the x, y data.
                                             </para>
                                         </listitem>
                                     </varlistentry>
                                     <varlistentry>
                                         <term>y=5</term>
                                         <listitem>
-                                            <para>enlarged for pretty axes from the rect arg</para>
+                                            <para>enlarged for pretty axes from the
+                                                <varname>rect</varname> argument.
+                                            </para>
                                         </listitem>
                                     </varlistentry>
                                     <varlistentry>
                                         <term>y=6</term>
                                         <listitem>
-                                            <para>enlarged for pretty axes from the min/max of the
-                                                x, y data
+                                            <para>
+                                                enlarged for pretty axes from the min/max of the
+                                                x, y data.
                                             </para>
                                         </listitem>
                                     </varlistentry>
                                     <varlistentry>
                                         <term>y=7</term>
                                         <listitem>
-                                            <para>like y=1 but the previus plot(s) are redrawn to
-                                                use the new scale
+                                            <para>
+                                                like <literal>y=1</literal> but the previous plots
+                                                are redrawn to use the new scale.
                                             </para>
                                         </listitem>
                                     </varlistentry>
                                     <varlistentry>
                                         <term>y=8</term>
                                         <listitem>
-                                            <para>like y=2 but the previus plot(s) are redrawn to
-                                                use the new scale
+                                            <para>
+                                                like <literal>y=2</literal> but the previous plots
+                                                are redrawn to use the new scale.
                                             </para>
                                         </listitem>
                                     </varlistentry>
                         <varlistentry>
                             <term>z</term>
                             <listitem>
-                                <para>controls the display of information on the frame around
-                                    the plot. If axes are requested, the number of tics can be
-                                    specified by the <literal>nax</literal> optional argument.
+                                <para>
+                                    controls the display of information on the frame around
+                                    the plot. If axes are requested, the number of ticks can be
+                                    specified by the <varname>nax</varname> optional argument.
                                 </para>
                                 <variablelist>
                                     <varlistentry>
                                     <varlistentry>
                                         <term>z=1</term>
                                         <listitem>
-                                            <para>axes are drawn, the y=axis is displayed on the
+                                            <para>
+                                                axes are drawn, the y-axis is displayed on the
                                                 left.
                                             </para>
                                         </listitem>
                                     <varlistentry>
                                         <term>z=2</term>
                                         <listitem>
-                                            <para>the plot is surrounded by a box without tics.</para>
+                                            <para>
+                                                the plot is surrounded by a box without ticks.
+                                            </para>
                                         </listitem>
                                     </varlistentry>
                                     <varlistentry>
                                         <term>z=3</term>
                                         <listitem>
-                                            <para>axes are drawn, the y=axis is displayed on the
+                                            <para>
+                                                axes are drawn, the y-axis is displayed on the
                                                 right.
                                             </para>
                                         </listitem>
                                     <varlistentry>
                                         <term>z=4</term>
                                         <listitem>
-                                            <para>axes are drawn centred in the middle of the frame box,
+                                            <para>
+                                                axes are drawn centred in the middle of the frame box,
                                                 with the box disabled.
                                             </para>
                                         </listitem>
                                     <varlistentry>
                                         <term>z=5</term>
                                         <listitem>
-                                            <para>axes are drawn centred in the middle of the frame box,
+                                            <para>
+                                                axes are drawn centred in the middle of the frame box,
                                                 with the box enabled.
                                             </para>
                                         </listitem>
             <varlistentry>
                 <term>rect</term>
                 <listitem>
-                    <para>This argument is used when the second character y of argument
-                        <literal>strf</literal> is 1, 3 or 5. It is a row vector of size 4 and
-                        gives the dimension of the frame:
-                        <literal>rect=[xmin,ymin,xmax,ymax]</literal>.
+                    <para>
+                        This argument is used when the second character <literal>y</literal>
+                        of argument <varname>strf</varname> is <literal>1</literal>, 
+                        <literal>3</literal> or <literal>5</literal>. It is a row vector of
+                        size 4 and gives the dimension of the frame:
+                        <literal>rect = [xmin, ymin, xmax, ymax]</literal>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>nax</term>
                 <listitem>
-                    <para>This argument is used when the third character z of argument
-                        <literal>strf</literal> is 1. It is a row vector with four entries
-                        <literal>[nx,Nx,ny,Ny]</literal> where <literal>nx</literal> (<literal>ny</literal>)
+                    <para>
+                        This argument is used when the third character <literal>z</literal>
+                        of argument <varname>strf</varname> is <literal>1</literal>. It is
+                        a row vector with four entries <literal>[nx, Nx, ny, Ny]</literal>
+                        where <literal>nx</literal> (<literal>ny</literal>)
                         is the number of subgraduations on the x (y) axis and
                         <literal>Nx</literal> (<literal>Ny</literal>) is the number of graduations on
                         the x (y) axis.
     <refsection>
         <title>Description</title>
         <para>
-            The entries of matrix <literal>int(a)</literal> are used as colormap entries
-            in the current colormap.
-            The color associated to <literal>a(i,j)</literal> is
-            used do draw a small square of size 1 with center at location
-            <literal>(x=j,y=(n1-i+1))</literal>.
+            The entries of matrix <code>int(a)</code> are used as colormap entries
+            in the current colormap. The color associated to <literal>a(i,j)</literal>
+            is used to draw a small square of size 1 with center at location
+            <literal>(x=j, y=(n1-i+1))</literal>.
             If a matrix entry is outside the colormap, the corresponding rectangle is not displayed.
         </para>
         <para>
-            Enter the command <literal>Matplot()</literal> to see a demo.
+            Enter the command <code>Matplot()</code> to see a demo.
         </para>
     </refsection>
     <refsection>
index aa38896..758ea0b 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"  xml:lang="en" xml:id="Matplot1">
     <refnamediv>
         <refname>Matplot1</refname>
-        <refpurpose>2D plot of a matrix using
-            colors
+        <refpurpose>
+            2D plot of a matrix using colors
         </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>Matplot1(a,rect)</synopsis>
+        <synopsis>Matplot1(a, rect)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
             <varlistentry>
                 <term>a</term>
                 <listitem>
-                    <para>real matrix of size (n1,n2).</para>
+                    <para>
+                        a real matrix of size <literal>(n1,n2)</literal>.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>rect</term>
                 <listitem>
                     <para>
-                        <literal>[xmin,ymin,xmax,ymax]</literal>
+                        <literal>[xmin, ymin, xmax, ymax]</literal>.
                     </para>
                 </listitem>
             </varlistentry>
     <refsection>
         <title>Description</title>
         <para>
-            The entries of matrix <literal>int(a)</literal> are used as colormap entries
-            in the current colormap.  <literal>rect</literal> specify a rectangle in the
+            The entries of matrix <code>int(a)</code> are used as colormap entries
+            in the current colormap.  <varname>rect</varname> specifies a rectangle in the
             current scale and the matrix is drawn inside this rectangle. Each matrix
             entry will be rendered as a small rectangle filled with its associated
-            color. If a matrix entry is outside the colormap, the corresponding rectangle is not displayed.
+            color. If a matrix entry is outside the colormap, the corresponding rectangle
+            is not displayed.
+        </para>
+        <para>
+            Enter the command <code>Matplot1()</code> to see a demo.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[ 
 clf();
-ax=gca();//get current axes handle
-ax.data_bounds=[0,0;10,10];//set the data_bounds
-ax.box='on'; //draw a box
-a=5*ones(11,11);
-a(2:10,2:10)=4;
-a(5:7,5:7)=2;
+ax = gca();//get current axes handle
+ax.data_bounds = [0, 0; 10, 10]; //set the data_bounds
+ax.box = 'on'; //draw a box
+a = 5*ones(11,11);
+a(2:10, 2:10) = 4;
+a(5:7, 5:7) = 2;
 // first matrix in rectangle [1,1,3,3]
-Matplot1(a,[1,1,3,3])
-a=ones(10,10);
-a= 3*tril(a)+ 2*a;
+Matplot1(a, [1,1,3,3])
+a = ones(10,10);
+a = 3*tril(a)+ 2*a;
 // second matrix in rectangle [5,6,7,8]
 Matplot1(a,[5,6,7,8])
  ]]></programlisting>
@@ -84,7 +90,7 @@ n=100;
 
 clf();
 f=gcf();//get current figure handle
-f.pixmap='on';//double buffer mode
+f.pixmap='on';//double buffer modea
 ax=gca();//get current axes handle
 ax.data_bounds=[0,0;10,10];//set the data_bounds
 ax.box='on'; //draw a box