Revision of help pages for mesh function (en_US, pt_BR). 35/10435/1
Stanislav KROTER [Sat, 9 Feb 2013 05:43:35 +0000 (11:43 +0600)]
Change-Id: I799f5922b085fa90d2c83a0e2c6865594e2cfac0

scilab/modules/graphics/help/en_US/3d_plot/mesh.xml
scilab/modules/graphics/help/pt_BR/3d_plot/mesh.xml

index c1da5ad..1809ed8 100644 (file)
             <varlistentry>
                 <term>Z</term>
                 <listitem>
-                    <para>a real matrix defining the surface height. It can not be
-                        omitted. The Z data is a<literal> m</literal>x<literal>n</literal> matrix.
+                    <para>
+                       a real matrix defining the surface height. It can not be
+                        omitted. The <varname>Z</varname> data is a 
+                       <literal>m</literal>-by-<literal>n</literal> matrix.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>X,Y</term>
+                <term>X, Y</term>
                 <listitem>
-                    <para>two real matrices : always set together, these data defines a
-                        new standard grid. This new <literal>X</literal> and <literal>Y</literal>
-                        components of the grid must match <literal>Z</literal> dimensions (see
+                    <para>
+                       two real matrices : always set together, these data defines a
+                        new standard grid. This new <varname>X</varname> and <varname>Y</varname> 
+                        components of the grid must match <varname>Z</varname> dimensions (see
                         description below).
                     </para>
                 </listitem>
@@ -48,7 +51,8 @@
             <varlistentry>
                 <term>color</term>
                 <listitem>
-                    <para>an optional real matrix defining a color value for each
+                    <para>
+                       an optional real matrix defining a color value for each
                         <literal>(X(j),Y(i))</literal> point of the grid (see description
                         below).
                     </para>
@@ -57,7 +61,8 @@
             <varlistentry>
                 <term>&lt;GlobalProperty&gt;</term>
                 <listitem>
-                    <para>This optional argument represents a sequence of couple
+                    <para>
+                       this optional argument represents a sequence of couple
                         statements <literal>{PropertyName,PropertyValue}</literal> that defines
                         global objects' properties applied to all the curves created by this
                         plot. For a complete view of the available properties (see
@@ -68,8 +73,9 @@
             <varlistentry>
                 <term>&lt;axes_handle&gt;</term>
                 <listitem>
-                    <para>This optional argument forces the plot to appear inside the
-                        selected axes given by <literal>axes_handle</literal> rather than the
+                    <para>
+                       this optional argument forces the plot to appear inside the
+                        selected axes given by <varname>axes_handle</varname> rather than the
                         current axes (see <link linkend="gca">gca</link>).
                     </para>
                 </listitem>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>mesh</literal> draws a parametric surface using a rectangular grid
-            defined by <literal>X</literal> and <literal>Y</literal> coordinates (if
+            <function>mesh</function> draws a parametric surface using a rectangular grid
+            defined by <varname>X</varname> and <varname>Y</varname> coordinates (if
             <literal>{X,Y}</literal> are not specified, this grid is determined using the
-            dimensions of the <literal>Z</literal> matrix) ; at each point of this grid, a Z
-            coordinate is given using the <literal>Z</literal> matrix. <literal>mesh</literal> is
-            based on the <literal>surf</literal> command with default option
+            dimensions of the <varname>Z</varname> matrix); at each point of this grid, a z
+            coordinate is given using the <varname>Z</varname> matrix. <function>mesh</function> is
+            based on the <function>surf</function> command with default option
             <literal>color_mode</literal> = white index (inside the current colormap) and
             <literal>color_flag</literal> = 0.
         </para>
         <para>Data entry specification :</para>
-        <para>In this paragraph and to be more clear, we won't mention
-            <literal>GlobalProperty</literal> optional arguments as they do not interfer
-            with entry data (except for <literal>"Xdata"</literal>, <literal>"Ydata"</literal> and
-            <literal>"Zdata"</literal> property, see <link linkend="GlobalProperty">GlobalProperty</link>). It is
+        <para>
+           In this paragraph and to be more clear, we won't mention
+            <varname>GlobalProperty</varname> optional arguments as they do not interfer
+            with entry data (except for <literal>"Xdata"</literal>,
+           <literal>"Ydata"</literal> and <literal>"Zdata"</literal>
+           property, see <link linkend="GlobalProperty">GlobalProperty</link>). It is
             assumed that all those optional arguments could be present too.
         </para>
         <para>
-            If <literal>Z</literal> is the only matrix specified, (Z) plots the matrix
-            <literal>Z</literal> versus the grid defined by <literal>1:size(Z,2)</literal> along
-            the x axis and <literal>1:size(Z,1)</literal> along the y axis.
+            If <varname>Z</varname> is the only matrix specified, <code>mesh(Z)</code>
+           plots the matrix <varname>Z</varname> versus the grid defined by
+           <code>1:size(Z,2)</code> along the x axis and <code>1:size(Z,1)</code>
+           along the y axis.
         </para>
     </refsection>
     <refsection>
         <title>Remarks</title>
         <para>
-            To enable the tranparency mode you should set the <literal>color_mode
-            </literal>
-            option to 0.
+            To enable the tranparency mode you should set the 
+           <literal>color_mode</literal> option to 0.
         </para>
     </refsection>
     <refsection>
         <programlisting role="example"><![CDATA[ 
 [X,Y]=meshgrid(-1:.1:1,-1:.1:1);
 Z=X.^2-Y.^2;
-xtitle('z=x2-y ^2');
+xtitle('z=x^2-y^2');
 mesh(X,Y,Z);
  ]]></programlisting>
         <scilab:image>
             [X,Y]=meshgrid(-1:.1:1,-1:.1:1);
             Z=X.^2-Y.^2;
-            xtitle('z=x2-y ^2');
+            xtitle('z=x^2-y^2');
             mesh(X,Y,Z);
         </scilab:image>
     </refsection>
index 99a317d..88cbf73 100644 (file)
                 <term>Z</term>
                 <listitem>
                     <para>matriz de reais definindo a altura da superfície. Não pode ser
-                        omitida. O dado Z é uma matriz<literal>
-                            m
-                        </literal>
-                        x<literal>n</literal>.
+                        omitida. O dado <varname>Z</varname> é uma matriz
+                                               <literal>m</literal> x <literal>n</literal>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>X,Y</term>
+                <term>X, Y</term>
                 <listitem>
                     <para>duas matrizes de reais: sempre ajustadas juntas, esses dados
                         definem um novo grid padrão. Estes novos componentes
-                        <literal>X</literal> e <literal>Y</literal> do grid devem coincidir
-                        com as dimensões de <literal>Z</literal> (ver descrição abaixo).
+                        <varname>X</varname> e <varname>Y</varname> do grid devem coincidir
+                        com as dimensões de <varname>Z</varname> (ver descrição abaixo).
                     </para>
                 </listitem>
             </varlistentry>
@@ -71,7 +69,7 @@
                 <term>&lt;axes_handle&gt;</term>
                 <listitem>
                     <para>este argumento opcional força o esboço a aparecer dentro dos
-                        eixos selecionados por <literal>axes_handle</literal> ao invés dos
+                        eixos selecionados por <varname>axes_handle</varname> ao invés dos
                         eixos correntes (ver <link linkend="gca">gca</link>).
                     </para>
                 </listitem>
     <refsection>
         <title>Descrição</title>
         <para>
-            <literal>mesh</literal> desenha uma superfície parametrizada
+            <function>mesh</function> desenha uma superfície parametrizada
             utilizando um grid retangular definido pelas coordenadas
-            <literal>X</literal> e <literal>Y</literal> (se <literal>{X,Y}</literal>
+             <varname>X</varname>  e  <varname>Y</varname>  (se <literal>{X,Y}</literal>
             não são especificados, este grid é determinado utilizando-se as dimensões
-            da matriz <literal>Z</literal> ) ; em cada ponto deste grid, uma
-            coordenada Z é dada utilizando-se a matriz <literal>Z</literal>.
-            <literal>mesh</literal> é baseado no comando <literal>surf</literal> com a
+            da matriz  <varname>Z</varname>) ; em cada ponto deste grid, uma
+            coordenada <varname>Z</varname> é dada utilizando-se a matriz <varname>Z</varname>.
+            <function>mesh</function> é baseado no comando <function>surf</function> com a
             opção padrão <literal>color_mode</literal> = índice de branco (dentro do
             mapa de cores corrente) e <literal>color_flag</literal> = 0.
         </para>
         <para>Especificação de dados de entrada:</para>
         <para>Neste parágrafo, para sermos mais claros, não mencionaremos os
-            argumentos opcionais <literal>GlobalProperty</literal> já que eles não
+            argumentos opcionais <varname> GlobalProperty</varname>  já que eles não
             interferem na entrada de dados (exceto pelas propriedades
             <literal>"Xdata"</literal>, <literal>"Ydata"</literal> e
             <literal>"Zdata"</literal>, ver <link linkend="GlobalProperty">GlobalProperty</link>). Assume-se que todos estes
             argumentos opcionais poderiam estar presentes também.
         </para>
         <para>
-            Se <literal>Z</literal> é a única matriz especificada, (Z) esboça a
-            matriz <literal>Z</literal> versus o grid definido por
-            <literal>1:size(Z,2)</literal> ao longo do eixo x e
-            <literal>1:size(Z,1)</literal> ao longo do eixo y.
+            Se  <varname>Z</varname>  é a única matriz especificada, <code>mesh(Z)</code> esboça a
+            matriz  <varname>Z</varname>  versus o grid definido por
+            <code>1:size(Z,2)</code> ao longo do eixo x e
+            <code>1:size(Z,1)</code> ao longo do eixo y.
         </para>
     </refsection>
     <refsection>
         <programlisting role="example"><![CDATA[ 
 [X,Y]=meshgrid(-1:.1:1,-1:.1:1);
 Z=X.^2-Y.^2;
-xtitle('z=x2-y ^2');
+xtitle('z=x^2-y^2');
 mesh(X,Y,Z);
  ]]></programlisting>
+        <scilab:image>
+            [X,Y]=meshgrid(-1:.1:1,-1:.1:1);
+            Z=X.^2-Y.^2;
+            xtitle('z=x^2-y^2');
+            mesh(X,Y,Z);
+        </scilab:image>
     </refsection>
     <refsection>
         <title>Ver Também </title>