Revision of help page for contourf function (en_US).
[scilab.git] / scilab / modules / graphics / help / en_US / 2d_plot / contourf.xml
index 37e6bde..5f7cb58 100644 (file)
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>contourf(x,y,z,nz,[style,strf,leg,rect,nax])</synopsis>
+        <synopsis>
+            contourf(x, y, z, nz, [style, strf, leg, rect, nax])
+        </synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
         <variablelist>
             <varlistentry>
-                <term>x,y</term>
+                <term>x, y</term>
                 <listitem>
-                    <para>two real row vectors of size n1 and n2: the grid.</para>
+                    <para>
+                        two real row vectors of size <literal>n1</literal> and <literal>n2</literal>: the grid.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>z</term>
                 <listitem>
-                    <para>real matrix of size (n1,n2), the values of the
-                        function.
+                    <para>
+                        a real matrix of size <literal>(n1,n2)</literal>, the
+                        values of the function.
                     </para>
                 </listitem>
             </varlistentry>
                             <term>-</term>
                             <listitem>
                                 <para>
-                                    If <literal>nz</literal> is an integer, its value gives
-                                    the number of level curves equally spaced from zmin to zmax as
-                                    follows:
+                                    If <varname>nz</varname> is an integer, its
+                                    value gives the number of level curves
+                                    equally spaced from <literal>zmin</literal>
+                                    to <literal>zmax</literal> as follows:
                                 </para>
                                 <programlisting role="no-scilab-exec"><![CDATA[ 
 z= zmin + (1:nz)*(zmax-zmin)/(nz+1)
  ]]></programlisting>
                                 <para>
+                                    <note>
                                     Note: that the <literal>zmin</literal> and
-                                    <literal>zmax</literal> levels are not drawn (generically they
-                                    are reduced to points) but they can be added with
+                                    <literal>zmax</literal> levels are not drawn
+                                    (generically they are reduced to points) but
+                                    they can be added with
+                                    </note>
                                 </para>
                                 <programlisting role="no-scilab-exec"><![CDATA[ 
 [im,jm] = find(z == zmin);     // or zmax 
@@ -67,9 +76,9 @@ plot2d(x(im)',y(jm)',-9,"000")
                             <term>-</term>
                             <listitem>
                                 <para>
-                                    If <literal>nz</literal> is a vector,
-                                    <literal>nz(i)</literal> gives the value of the ith level
-                                    curve.
+                                    If <varname>nz</varname> is a vector,
+                                    <literal>nz(i)</literal> gives the value of
+                                    the <literal>i</literal>-th level curve.
                                 </para>
                             </listitem>
                         </varlistentry>
@@ -77,13 +86,13 @@ plot2d(x(im)',y(jm)',-9,"000")
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>style,strf,leg,rect,nax</term>
+                <term>style, strf, leg, rect, nax</term>
                 <listitem>
                     <para>
-                        see <literal>plot2d</literal>. The argument
-                        <literal>style</literal> gives the colors which are to be used for
-                        level curves. It must have the same size as the number of
-                        levels.
+                        see <function>plot2d</function>. The argument
+                        <varname>style</varname> gives the colors which are to
+                        be used for level curves. It must have the same size as
+                        the number of levels.
                     </para>
                 </listitem>
             </varlistentry>
@@ -92,21 +101,21 @@ plot2d(x(im)',y(jm)',-9,"000")
     <refsection>
         <title>Description</title>
         <para>
-            <literal>contourf</literal> paints surface between two consecutives
-            level curves of a surface <literal>z=f(x,y)</literal> on a 2D plot. The
-            values of <literal>f(x,y)</literal> are given by the matrix
-            <literal>z</literal> at the grid points defined by <literal>x</literal>
-            and <literal>y</literal>.
+            <function>contourf</function> paints surface between two consecutive
+            level curves of a surface <literal>z=f(x,y)</literal> on a 2D plot.
+            The values of <literal>f(x,y)</literal> are given by the matrix
+            <varname>z</varname> at the grid points defined by
+            <varname>x</varname> and <varname>y</varname>.
         </para>
-        <para>You can change the format of the floating point number printed on
-            the levels by using <literal>xset("fpf",string)</literal> where
-            <literal>string</literal> gives the format in C format syntax (for example
-            <literal>string="%.3f"</literal>). Use <literal>string=""</literal> to
+        <para>
+            You can change the format of the floating point number printed on
+            the levels by using <code>xset("fpf",string)</code> where
+            <varname>string</varname> gives the format in C format syntax (for
+            example <code>string="%.3f"</code>). Use <code>string=""</code> to
             switch back to default format.
         </para>
         <para>
-            Enter the command <literal>contourf()</literal> to see a
-            demo.
+            Enter the command <code>contourf()</code> to see a demo.
         </para>
     </refsection>
     <refsection>
@@ -184,10 +193,7 @@ contourf([],[],z,[-6:-1,-logspace(-5,0,10),logspace(-5,0,10),1:8]);
                 <link linkend="contour">contour</link>
             </member>
             <member>
-                <link linkend="fcontour">fcontour</link>
-            </member>
-            <member>
-                <link linkend="fcontour2d">fcontour2d</link>
+                <link linkend="contour2d">contour2d</link>
             </member>
             <member>
                 <link linkend="contour2di">contour2di</link>
@@ -195,9 +201,6 @@ contourf([],[],z,[-6:-1,-logspace(-5,0,10),logspace(-5,0,10),1:8]);
             <member>
                 <link linkend="plot2d">plot2d</link>
             </member>
-            <member>
-                <link linkend="xset">xset</link>
-            </member>
         </simplelist>
     </refsection>
 </refentry>