Revision of help page for Sfgrayplot function. 97/10597/1
Stanislav KROTER [Mon, 25 Feb 2013 05:49:15 +0000 (10:49 +0500)]
Change-Id: Iccfe7d57b3cc1c35b5605c1bcfc1c24911bc1502

scilab/modules/graphics/help/en_US/2d_plot/Sfgrayplot.xml

index cc71985..010255a 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="Sfgrayplot">
     <refnamediv>
         <refname>Sfgrayplot</refname>
-        <refpurpose>smooth 2D plot of a surface defined by a function using colors
+        <refpurpose>
+            smooth 2D plot of a surface defined by a function using colors
         </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>Sfgrayplot(x,y,f,&lt;opt_args&gt;)
-            Sfgrayplot(x,y,f [,strf, rect, nax, zminmax, colminmax, mesh, colout])
+        <synopsis>
+            Sfgrayplot(x, y, f, &lt;opt_args&gt;)
+            Sfgrayplot(x, y, f [,strf, rect, nax, zminmax, colminmax, mesh, colout])
         </synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
         <variablelist>
             <varlistentry>
-                <term>x,y</term>
+                <term>x, y</term>
                 <listitem>
-                    <para>real row vectors of size n1 and n2.</para>
+                    <para>
+                        real row vectors of size <literal>n1</literal> and <literal>n2</literal>.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>f</term>
                 <listitem>
-                    <para>scilab function (z=f(x,y))</para>
+                    <para>
+                        a scilab function (<literal>z=f(x,y)</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: strf, rect, nax, zminmax, colminmax, mesh, colout
-                        (see <link linkend="plot2d">plot2d</link> for the 3 first and <link linkend="fec">fec</link> for the 4 last).
+                        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: <varname>strf</varname>,
+                         <varname>rect</varname>, <varname>nax</varname>,
+                         <varname>zminmax</varname>, <varname>colminmax</varname>,
+                         <varname>mesh</varname>, <varname>colout</varname>
+                        (see <link linkend="plot2d">plot2d</link> for the 3 first
+                        and <link linkend="fec">fec</link> for the 4 last).
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>strf,rect,nax</term>
+                <term>strf, rect, nax</term>
                 <listitem>
                     <para>
                         see <link linkend="plot2d">plot2d</link>.
     <refsection>
         <title>Description</title>
         <para>
-            <literal>Sfgrayplot</literal> is the same as <literal>fgrayplot</literal> but the
-            plot is smoothed. The function <literal>fec</literal> is used for smoothing. The
+            <function>Sfgrayplot</function> is the same as <function>fgrayplot</function> but the
+            plot is smoothed. The function <function>fec</function> is used for smoothing. The
             surface is plotted assuming that it is linear on a set of triangles built
-            from the grid (here with n1=5, n2=3):
+            from the grid (here with <literal>n1=5</literal>, <literal>n2=3</literal>):
         </para>
         <screen><![CDATA[ 
 _____________
@@ -88,11 +97,11 @@ _____________
             you must know (or compute) the min and max values).
         </para>
         <para>
-            Instead of Sfgrayplot, you can use <link linkend="Sgrayplot">Sgrayplot</link> and this may be
+            Instead of <function>Sfgrayplot</function>, you can use <link linkend="Sgrayplot">Sgrayplot</link> and this may be
             a little faster.
         </para>
         <para>
-            Enter the command <literal>Sfgrayplot()</literal> to see a demo.
+            Enter the command <code>Sfgrayplot()</code> to see a demo.
         </para>
     </refsection>
     <refsection>
@@ -166,7 +175,7 @@ xset("colormap",hotcolormap(128))
 drawlater() ;
 colorbar(-1,2)
 Sfgrayplot(x,y,surf3,strf="041")
-fcontour2d(x,y,surf3,[-0.1, 0.025, 0.4],style=[1 1 1],strf="000")
+contour2d(x,y,surf3,[-0.1, 0.025, 0.4],style=[1 1 1],strf="000")
 xtitle("f(x,y) = x^3+y^2")
 drawnow() ;
 show_window()
@@ -180,7 +189,7 @@ show_window()
             drawlater() ;
             colorbar(-1,2)
             Sfgrayplot(x,y,surf3,strf="041")
-            fcontour2d(x,y,surf3,[-0.1, 0.025, 0.4],style=[1 1 1],strf="000")
+            contour2d(x,y,surf3,[-0.1, 0.025, 0.4],style=[1 1 1],strf="000")
             xtitle("f(x,y) = x^3+y^2")
             drawnow() ;
             show_window()
@@ -197,7 +206,7 @@ drawlater() ;
 zminmax = [-0.5 1]; colors=[32 96];
 colorbar(zminmax(1),zminmax(2),colors)
 Sfgrayplot(x, y, surf3, strf="041", zminmax=zminmax, colout=[0 0], colminmax=colors)
-fcontour2d(x,y,surf3,[-0.5, 1],style=[1 1 1],strf="000")
+contour2d(x,y,surf3,[-0.5, 1],style=[1 1 1],strf="000")
 xtitle("f(x,y) = x^3+y^2, with parts under z = -0.5 and upper z = 1 removed")
 drawnow() ;
 show_window()
@@ -212,7 +221,7 @@ show_window()
             zminmax = [-0.5 1]; colors=[32 96];
             colorbar(zminmax(1),zminmax(2),colors)
             Sfgrayplot(x, y, surf3, strf="041", zminmax=zminmax, colout=[0 0], colminmax=colors)
-            fcontour2d(x,y,surf3,[-0.5, 1],style=[1 1 1],strf="000")
+            contour2d(x,y,surf3,[-0.5, 1],style=[1 1 1],strf="000")
             xtitle("f(x,y) = x^3+y^2, with parts under z = -0.5 and upper z = 1 removed")
             drawnow() ;
             show_window()