Revision of help pages for xarrows function. 71/10471/1
Stanislav KROTER [Thu, 14 Feb 2013 09:54:25 +0000 (14:54 +0500)]
1) The argument "style" now is "color" because it changes only color of arrows and nothing else.
2) In the Examples: 8-th color (white) is missed because white arrow on white background can confuse.

Change-Id: I6fb937805b38a4e87a866d91760994cf708faa4a

scilab/modules/graphics/help/en_US/geometric_shapes/xarrows.xml
scilab/modules/graphics/help/fr_FR/geometric_shapes/xarrows.xml
scilab/modules/graphics/help/ja_JP/geometric_shapes/xarrows.xml
scilab/modules/graphics/help/pt_BR/geometric_shapes/xarrows.xml

index 48f5511..e3dba15 100644 (file)
@@ -2,11 +2,11 @@
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) ENPC - Jean-Philippe Chancelier
- * 
+ *
  * This file must be used under the terms of the CeCILL.
  * This source file is licensed as described in the file COPYING, which
  * you should have received as part of this distribution.  The terms
- * are also available at    
+ * are also available at
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>xarrows(nx,ny,[arsize,style])</synopsis>
+        <synopsis>xarrows(nx, ny, [arsize, color])</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
         <variablelist>
             <varlistentry>
-                <term>nx,ny</term>
+                <term>nx, ny</term>
                 <listitem>
                     <para>real vectors or matrices of same size.</para>
                 </listitem>
             <varlistentry>
                 <term>arsize</term>
                 <listitem>
-                    <para>real scalar, size of the arrow head. The default value can be obtained  by setting arsize to -1.</para>
+                    <para>
+                        a real scalar, size of the arrow head.
+                        The default value can be obtained  by
+                        setting <varname>arsize</varname> to
+                        <literal>-1</literal>.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>style</term>
+                <term>color</term>
                 <listitem>
                     <para>
-                        matrix or scalar. If <literal>style</literal> is a positive scalar  it gives the color to use for all arrows. If it is a negative scalar  then the current color is used. If it is a vector <literal>style(i)</literal> gives the color to use for arrow <literal>i</literal>.
+                        a matrix or scalar. If <varname>color</varname>
+                        is a positive scalar it gives the color
+                        to use for all arrows. If it is a
+                        negative scalar then the current color is
+                        used. If it is a vector <literal>color(i)</literal>
+                        gives the color to use for arrow <literal>i</literal>.
                     </para>
                 </listitem>
             </varlistentry>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xarrows</literal> draws a set of arrows given by <literal>nx</literal> and <literal>ny</literal>.
-            If <literal>nx</literal> and <literal>ny</literal> are vectors,
-            the ith arrow is defined by
+            <function>xarrows</function> draws a set of arrows
+            given by <varname>nx</varname> and <varname>ny</varname>.
+            If <varname>nx</varname> and <varname>ny</varname> are vectors,
+            the <literal>i</literal>-th arrow is defined by
             <literal>(nx(i),ny(i))--&gt;(nx(i+1),ny(i+1))</literal>.
-            If <literal>nx</literal> and <literal>ny</literal> are matrices:
+            If <varname>nx</varname> and <varname>ny</varname> are matrices:
         </para>
-        <programlisting role="no-scilab-exec"><![CDATA[ 
+        <programlisting role="no-scilab-exec"><![CDATA[
 nx=[xi_1 x1_2 ...; xf_1 xf_2 ...]
 ny=[yi_1 y1_2 ...; yf_1 yf_2 ...]
  ]]></programlisting>
         <para>
-            the <literal>k</literal> th arrow is defined by <literal>(xi_k,yi_k)--&gt;(xf_k,yf_k)</literal>.
+            the <literal>k</literal>-th arrow is defined by <literal>(xi_k,yi_k)--&gt;(xf_k,yf_k)</literal>.
         </para>
         <para>
-            <literal>xarrows</literal> uses the current graphics scale 
-            which can be set by calling a high level drawing function such as <literal>plot2d</literal>.
+            <function>xarrows</function> uses the current graphics
+            scale which can be set by calling a high level
+            drawing function such as <function>plot2d</function>.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
-x=2*%pi*(0:9)/8;
-x1=[sin(x); 9*sin(x)];
-y1=[cos(x); 9*cos(x)];
+        <programlisting role="example"><![CDATA[
+x = 2*%pi*(0:7)/8
+x1 = [sin(x); 9*sin(x)];
+y1 = [cos(x); 9*cos(x)];
 plot2d([-10,10], [-10,10], [-1,-1], "022")
 xset("clipgrf")
-xarrows(x1, y1, 1, 1:10)
+xarrows(x1, y1, -1, [1:7,9]) //8-th color is white
 xset("clipoff")
  ]]></programlisting>
         <scilab:image>
-            x=2*%pi*(0:9)/8;
-            x1=[sin(x); 9*sin(x)];
-            y1=[cos(x); 9*cos(x)];
+            x = 2*%pi*(0:7)/8
+            x1 = [sin(x); 9*sin(x)];
+            y1 = [cos(x); 9*cos(x)];
             plot2d([-10,10], [-10,10], [-1,-1], "022")
             xset("clipgrf")
-            xarrows(x1, y1, 1, 1:10)
+            xarrows(x1, y1, -1, [1:7,9]) //8-th color is white
             xset("clipoff")
         </scilab:image>
     </refsection>
index 16ad872..fc8067e 100644 (file)
@@ -6,13 +6,13 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Séquence d'appel</title>
-        <synopsis>xarrows(nx,ny,[arsize,style])</synopsis>
+        <synopsis>xarrows(nx, ny, [arsize, color])</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Paramètres</title>
         <variablelist>
             <varlistentry>
-                <term>nx,ny  </term>
+                <term>nx, ny  </term>
                 <listitem>
                     <para>valeurs réelles ou matrices de même taille.
                     </para>
             <varlistentry>
                 <term>arsize  </term>
                 <listitem>
-                    <para>réel, taille des têtes des flèches. La valeur par défaut peut être obtenue  en prenant arsize = -1.
+                    <para>réel, taille des têtes des flèches. La valeur par défaut peut être obtenue  en prenant <varname>arsize</varname> = -1.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>style  </term>
+                <term>color  </term>
                 <listitem>
                     <para>
-                        matrice ou scalaire. Si <literal>style</literal> est positif il donne la couleur de ligne pour toutes les flèches. S'il est négatif  la couleur courante est utilisé. S'il est un vecteur, <literal>style(i)</literal> donne la couleur pour la flèche <literal>i</literal>.
+                        matrice ou scalaire. Si <varname>color</varname> est positif il donne la couleur de ligne pour toutes les flèches. S'il est négatif  la couleur courante est utilisé. S'il est un vecteur, <literal>color(i)</literal> donne la couleur pour la flèche <literal>i</literal>.
                     </para>
                 </listitem>
             </varlistentry>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>xarrows</literal> dessine un ensemble de flèches données par <literal>nx</literal> et <literal>ny</literal>.
-            Si <literal>nx</literal> et <literal>ny</literal> sont des vecteurs,
+            <function>xarrows</function> dessine un ensemble de flèches données par <varname>nx</varname> et <varname>ny</varname>.
+            Si <varname>nx</varname> et <varname>ny</varname> sont des vecteurs,
             la flèche numéro i est définie par
             <literal>(nx(i),ny(i))--&gt;(nx(i+1),ny(i+1))</literal>.
-            Si <literal>nx</literal> et <literal>ny</literal> sont des matrices :
+            Si <varname>nx</varname> et <varname>ny</varname> sont des matrices :
         </para>
         <programlisting role=""><![CDATA[ 
-nx=[xi_1 x1_2 ...; xf_1 xf_2 ...]
-ny=[yi_1 y1_2 ...; yf_1 yf_2 ...]
+nx = [xi_1 x1_2 ...; xf_1 xf_2 ...]
+ny = [yi_1 y1_2 ...; yf_1 yf_2 ...]
  ]]></programlisting>
         <para>
             la flèche numéro <literal>k</literal> est définie par <literal>(xi_k,yi_k)--&gt;(xf_k,yf_k)</literal>.
         </para>
         <para>
-            <literal>xarrows</literal> utilise l'échelle graphique courante, qui peut être définie par appel préalable d'une fonction graphique de haut niveau comme <literal>plot2d</literal>.
+            <function>xarrows</function> utilise l'échelle graphique courante, qui peut être définie par appel préalable d'une fonction graphique de haut niveau comme <function>plot2d</function>.
         </para>
     </refsection>
     <refsection>
         <title>Exemples</title>
         <programlisting role="example"><![CDATA[ 
-x=2*%pi*(0:9)/8;
-x1=[sin(x);9*sin(x)];
-y1=[cos(x);9*cos(x)];
-plot2d([-10,10],[-10,10],[-1,-1],"022")
+x = 2*%pi*(0:7)/8
+x1 = [sin(x); 9*sin(x)];
+y1 = [cos(x); 9*cos(x)];
+plot2d([-10,10], [-10,10], [-1,-1], "022")
 xset("clipgrf")
-xarrows(x1,y1,1,1:10)
+xarrows(x1, y1, -1, [1:7,9]) //8-th color is white
 xset("clipoff")
  ]]></programlisting>
         <scilab:image>
-            x=2*%pi*(0:9)/8;
-            x1=[sin(x); 9*sin(x)];
-            y1=[cos(x); 9*cos(x)];
+            x = 2*%pi*(0:7)/8
+            x1 = [sin(x); 9*sin(x)];
+            y1 = [cos(x); 9*cos(x)];
             plot2d([-10,10], [-10,10], [-1,-1], "022")
             xset("clipgrf")
-            xarrows(x1, y1, 1, 1:10)
+            xarrows(x1, y1, -1, [1:7,9]) //8-th color is white
             xset("clipoff")
         </scilab:image>
     </refsection>
index ce69c6b..9d06d11 100644 (file)
@@ -17,7 +17,7 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>呼び出し手順</title>
-        <synopsis>xarrows(nx,ny,[arsize,style])</synopsis>
+        <synopsis>xarrows(nx, ny, [arsize, color])</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>引数</title>
                 <term>arsize</term>
                 <listitem>
                     <para>実数スカラー, 矢じりの大きさ. 
-                        デフォルト値は arsize を -1 に設定することにより得られます.
+                        デフォルト値は <varname>arsize</varname> を -1 に設定することにより得られます.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>style</term>
+                <term>color</term>
                 <listitem>
                     <para>行列またはスカラー. 
-                        <literal>style</literal>が正のスカラーの場合,
+                        <varname>color</varname>が正のスカラーの場合,
                         この値は全ての矢印に使用される色を指定します.
                         負のスカラーの場合,カレントの色が使用されます.
-                        ベクトルの場合,<literal>style(i)</literal> は <literal>i</literal>番目の
+                        ベクトルの場合,<literal>color(i)</literal> は <literal>i</literal>番目の
                         矢印に使用される色を指定します.
                     </para>
                 </listitem>
     <refsection>
         <title>説明</title>
         <para>
-            <literal>xarrows</literal>は<literal>nx</literal> および <literal>ny</literal>
+            <function>xarrows</function>は<varname>nx</varname> および <varname>ny</varname>
             により指定される矢印の集合を描画します.
-            <literal>nx</literal> および <literal>ny</literal>がベクトルの場合,
+            <varname>nx</varname> および <varname>ny</varname>がベクトルの場合,
             i番目の矢印は
             <literal>(nx(i),ny(i))--&gt;(nx(i+1),ny(i+1))</literal>により定義されます.
-            <literal>nx</literal> および <literal>ny</literal> が行列の場合:
+            <varname>nx</varname> および <varname>ny</varname> が行列の場合:
         </para>
         <programlisting role=""><![CDATA[ 
 nx=[xi_1 x1_2 ...; xf_1 xf_2 ...]
@@ -69,32 +69,32 @@ ny=[yi_1 y1_2 ...; yf_1 yf_2 ...]
             により定義されます.
         </para>
         <para>
-            <literal>xarrows</literal>は,
-            <literal>plot2d</literal>のような高レベル関数をコールすることにより
+            <function>xarrows</function>は,
+            <function>plot2d</function>のような高レベル関数をコールすることにより
             設定可能なカレントのグラフィックスケールを使用します.
         </para>
     </refsection>
     <refsection>
         <title>例</title>
         <scilab:image>
-            x=2*%pi*(0:9)/8;
-            x1=[sin(x); 9*sin(x)];
-            y1=[cos(x); 9*cos(x)];
+            x = 2*%pi*(0:7)/8
+            x1 = [sin(x); 9*sin(x)];
+            y1 = [cos(x); 9*cos(x)];
             plot2d([-10,10], [-10,10], [-1,-1], "022")
             xset("clipgrf")
-            xarrows(x1, y1, 1, 1:10)
+            xarrows(x1, y1, -1, [1:7,9]) //8-th color is white
             xset("clipoff")
         </scilab:image>
     </refsection>
     <refsection>
         <title>例</title>
         <programlisting role="example"><![CDATA[ 
-x=2*%pi*(0:9)/8;
-x1=[sin(x);9*sin(x)];
-y1=[cos(x);9*cos(x)];
-plot2d([-10,10],[-10,10],[-1,-1],"022")
+x = 2*%pi*(0:7)/8
+x1 = [sin(x); 9*sin(x)];
+y1 = [cos(x); 9*cos(x)];
+plot2d([-10,10], [-10,10], [-1,-1], "022")
 xset("clipgrf")
-xarrows(x1,y1,1,1:10)
+xarrows(x1, y1, -1, [1:7,9]) //8-th color is white
 xset("clipoff")
  ]]></programlisting>
     </refsection>
index f91047f..1b6eb37 100644 (file)
@@ -17,7 +17,7 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Seqüência de Chamamento</title>
-        <synopsis>xarrows(nx,ny,[arsize,style])</synopsis>
+        <synopsis>xarrows(nx, ny, [arsize, color])</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Parâmetros</title>
                 <term>arsize</term>
                 <listitem>
                     <para>escalar real, o tamanho da cabeça da seta. O tamanho padrão
-                        pode ser obtido ajustando arsize para -1. 
+                        pode ser obtido ajustando <varname>arsize</varname> para -1. 
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>style</term>
+                <term>color</term>
                 <listitem>
                     <para>
-                        matriz ou escalar. Se <literal>style</literal> for um escalar
+                        matriz ou escalar. Se <varname>color</varname> for um escalar
                         positivo, fornece a cor a ser usada em todas as setas. Se for
                         negativo, a cor corrente é utilizada. Se for um vetor
-                        <literal>style(i)</literal> fornece a cor a ser utilizada no vetor
+                        <literal>color(i)</literal> fornece a cor a ser utilizada no vetor
                         <literal>i</literal>.
                     </para>
                 </listitem>
     <refsection>
         <title>Descrição</title>
         <para>
-            <literal>xarrows</literal> desenha um conjunto de setas dadas por
-            <literal>nx</literal> e <literal>ny</literal>. Se <literal>nx</literal> e
-            <literal>ny</literal> forem vetores, a i-ésima seta é definida por
+            <function>xarrows</function> desenha um conjunto de setas dadas por
+            <varname>nx</varname> e <varname>ny</varname>. Se <varname>nx</varname> e
+            <varname>ny</varname> forem vetores, a i-ésima seta é definida por
             <literal>(nx(i),ny(i))--&gt;(nx(i+1),ny(i+1))</literal>. Se
-            <literal>nx</literal> e <literal>ny</literal> são matrizes:
+            <varname>nx</varname> e <varname>ny</varname> são matrizes:
         </para>
         <programlisting role=""><![CDATA[ 
 nx=[xi_1 x1_2 ...; xf_1 xf_2 ...]
@@ -68,21 +68,30 @@ ny=[yi_1 y1_2 ...; yf_1 yf_2 ...]
             <literal>(xi_k,yi_k)--&gt;(xf_k,yf_k)</literal>.
         </para>
         <para>
-            <literal>xarrows</literal> utiliza a escala de gráficos corrente que
+            <function>xarrows</function> utiliza a escala de gráficos corrente que
             pode ser ajustada através de uma chamada a uma função de esboço de
-            alto-nível como <literal>plot2d</literal>.
+            alto-nível como <function>plot2d</function>.
         </para>
     </refsection>
     <refsection>
         <title>Exemplos</title>
         <programlisting role="example"><![CDATA[ 
-x=2*%pi*(0:9)/8;
-x1=[sin(x);9*sin(x)];
-y1=[cos(x);9*cos(x)];
-plot2d([-10,10],[-10,10],[-1,-1],"022")
+x = 2*%pi*(0:7)/8
+x1 = [sin(x); 9*sin(x)];
+y1 = [cos(x); 9*cos(x)];
+plot2d([-10,10], [-10,10], [-1,-1], "022")
 xset("clipgrf")
-xarrows(x1,y1,1,1:10)
+xarrows(x1, y1, -1, [1:7,9]) //8-th color is white
 xset("clipoff")
  ]]></programlisting>
+        <scilab:image>
+            x = 2*%pi*(0:7)/8
+            x1 = [sin(x); 9*sin(x)];
+            y1 = [cos(x); 9*cos(x)];
+            plot2d([-10,10], [-10,10], [-1,-1], "022")
+            xset("clipgrf")
+            xarrows(x1, y1, -1, [1:7,9]) //8-th color is white
+            xset("clipoff")
+        </scilab:image>
     </refsection>
 </refentry>