Help pages: various fixes 10/18310/8
Samuel GOUGEON [Sun, 26 Jun 2016 02:10:00 +0000 (04:10 +0200)]
Change-Id: Iace3f89e0cfc16e8256966a7b7f54ab090299257

18 files changed:
scilab/CHANGES.md
scilab/modules/core/help/fr_FR/scilab.xml
scilab/modules/data_structures/help/en_US/typeof.xml
scilab/modules/data_structures/help/fr_FR/typeof.xml
scilab/modules/development_tools/help/en_US/test_run.xml
scilab/modules/elementary_functions/help/en_US/matrixmanipulation/permute.xml
scilab/modules/graphics/help/en_US/2d_plot/comet.xml
scilab/modules/graphics/help/en_US/3d_plot/comet3d.xml
scilab/modules/graphics/help/ja_JP/2d_plot/comet.xml
scilab/modules/graphics/help/ja_JP/3d_plot/comet3d.xml
scilab/modules/graphics/help/ru_RU/2d_plot/comet.xml
scilab/modules/gui/help/en_US/close.xml
scilab/modules/localization/help/en_US/setlanguage.xml
scilab/modules/localization/help/fr_FR/setlanguage.xml
scilab/modules/localization/help/ja_JP/setlanguage.xml [deleted file]
scilab/modules/localization/help/ru_RU/setlanguage.xml [deleted file]
scilab/modules/time/help/en_US/sleep.xml
scilab/modules/time/help/fr_FR/sleep.xml

index 004848d..036741d 100644 (file)
@@ -145,10 +145,10 @@ Help pages:
 
 * CACSD and Signal Processing help pages have been sorted up.
 * fixed / improved:  `members`, `part`, `ode`, `ode_optional_output`, `ode_roots`, `roots`, `printf`, `sprintf`, `iconvert`, `stdev`, `xlabel`
-* rewriten: `consolebox`, `double`, `isoview`, `householder`, `or`, `and`, `format`, `typeof`
+* rewriten: `consolebox`, `double`, `isoview`, `householder`, `or`, `and`, `format`, `typeof`, `setlanguage`, `sleep`
 * resorted: `else`, `elseif`, `end`, `try`, `sciargs`, `global`, `halt`, `empty`, `power`
-* translations added:
-  - (fr): `format`, `typeof`, `isoview`, `ndgrid`, `bench_run`, `consolebox`, `harmean`
+* translations added or rewriten:
+  - (fr): `format`, `typeof`, `isoview`, `ndgrid`, `bench_run`, `consolebox`, `harmean`, `sleep`
   - (ru): homepage
 * added: support to `valign=".."` and `style="white-space:nowrap"` attributes for `<td>` and `<th>` tags
 
index 69947f3..a87652f 100644 (file)
                 <revnumber>5.4.0</revnumber>
                 <revremark>-noatomsautoload ajouté.</revremark>
             </revision>
-        </revhistory>
             <revision>
                 <revnumber>5.4.1</revnumber>
                 <revremark>scinotes et xcos peuvent maintenant être démarrés en ligne de commande. Voir le SEP #87.</revremark>
                     Option <literal>-quit</literal> ajoutée. Option <literal>-mem</literal> supprimée.
                 </revremark>
             </revision>
+        </revhistory>
     </refsection>
 </refentry>
index e84fd84..120d9be 100644 (file)
@@ -16,7 +16,7 @@
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="typeof" xml:lang="en">
     <refnamediv>
         <refname>typeof</refname>
-        <refpurpose>Human-readable type or overloading code of an object</refpurpose>
+        <refpurpose>explicit type or overloading code of an object</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Syntax</title>
index e9b4490..c32ec1d 100644 (file)
@@ -16,7 +16,7 @@
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="typeof" xml:lang="en">
     <refnamediv>
         <refname>typeof</refname>
-        <refpurpose>type d'un objet Scilab</refpurpose>
+        <refpurpose>type explicite ou code de surcharge d'un objet Scilab</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Syntaxe</title>
index 48384d2..ee1a343 100644 (file)
@@ -19,7 +19,7 @@
     <refnamediv>
         <refname>test_run</refname>
         <refpurpose>
-            Launches unit tests and non-regression test in a module or directory. The test run checks first that test scripts does not generate an error, then that the test diary (<literal>dia</literal> files) is the same as the reference diary (<literal>dia.ref</literal> files).
+            runs unit tests and non-regression tests of a module or in a directory
         </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
@@ -63,7 +63,9 @@
                 <term>test_name</term>
                 <listitem>
                     <para>
-                        A string array or <literal>[]</literal> (or equivalently <literal>"[]"</literal>). The names of the tests to execute during this run. If <literal>[]</literal> executes all tests found.
+                        A string array or <literal>[]</literal> or <literal>"[]"</literal>:
+                        The names of the tests to execute during this run. If <varname>test_name</varname>
+                        is <literal>[]</literal>, all tests found in the module or in the directory are executed.
                     </para>
                 </listitem>
             </varlistentry>
                         Note that the usage of this option enables <literal>show_diff</literal> and <literal>show_error</literal>.
                     </para>
                     <para>
-                        If the file pointed by <varname>exportToFile</varname> already exists, the new result will be added to the existing file.
+                        If the file pointed by <varname>exportToFile</varname> already exists,
+                        the new results are appended to the existing file.
                     </para>
                 </listitem>
             </varlistentry>
     <refsection>
         <title>Description</title>
         <para>
-            Search for .tst files in the unit test and non-regression test library
-            execute them, and display a report about success of failures.
-            The .tst files are searched in directories SCI+"/modules/*/tests/unit_tests"
-            and SCI+"/modules/*/tests/nonreg_tests".
+            Search for .tst files in the unit test and non-regression test library,
+            execute them, and display a report about success or failures.
+            The .tst files are searched in directories ~/tests/unit_tests"
+            and ~/tests/nonreg_tests" where "~" is the root directory of targeted modules.
         </para>
         <para>
             First <literal>test_run</literal> checks that a test does not produce an error.
         </para>
         <para>
-            Then <literal>test_run</literal> checks that the output and commands of a script are identical to the reference file. Whenever a test is executed, a <literal>.dia</literal> file is generated which contains
+            Then <literal>test_run</literal> checks that the output and commands of a script are
+            identical to the reference file. Whenever a test is executed, a <literal>.dia</literal>
+            file is generated which contains
             the full list of commands executed along with messages that appear in the
             console output. When the script is done, the <literal>.dia</literal> file is compared with
             the <literal>.dia.ref</literal> file which is expected to be in the same directory
index be7eb8f..dc5b88d 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:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="permute" xml:lang="en">
     <refnamediv>
         <refname>permute</refname>
-        <refpurpose>permute the dimensions of an array</refpurpose>
+        <refpurpose>permutes the dimensions of an array</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Syntax</title>
-        <synopsis>y=permute(x,dims)</synopsis>
+        <synopsis>y = permute(x, dims)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
             Permutes the dimensions of an array according to <varname>dims</varname>.
         </para>
         <para>
-            Input argument <varname>dims</varname> must be a valid permutation where dimension <literal>#i</literal> becomes <literal>#dims(i)</literal>.
+            Input argument <varname>dims</varname> must be a valid permutation, such as
+            the dimension <literal>#i</literal> becomes the dimension <literal>#dims(i)</literal>.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[
 //example 1:
-x=[1 2 3;4 5 6]
-y=permute(x,[2 1])
+x = [1 2 3;4 5 6]
+y = permute(x,[2 1])
 
 //example 2:
-x=matrix(1:12,[2,3,2])
-y=permute(x,[3 1 2])
+x = matrix(1:12,[2,3,2])
+y = permute(x,[3 1 2])
 
 x = matrix(1:12, [3 2 2])
 y = permute(x, [3 4 1 2])
index e4dbbb2..5933b4b 100644 (file)
     </refnamediv>
     <refsynopsisdiv>
         <title>Syntax</title>
-        <synopsis>comet(y)</synopsis>
-        <synopsis>comet(x,y)</synopsis>
-        <synopsis>comet(x,fun)</synopsis>
-        <synopsis>comet(x,y,p)</synopsis>
-        <synopsis>comet(x,fun,p)</synopsis>
-        <synopsis>comet(...,"colors",c)</synopsis>
+        <synopsis>
+          comet(y)
+          comet(x,y)
+          comet(x,fun)
+          comet(x,y,p)
+          comet(x,fun,p)
+          comet(...,"colors",c)
+        </synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Parameters</title>
index 4ba7837..8b5907f 100644 (file)
@@ -9,12 +9,14 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Syntax</title>
-        <synopsis>comet3d(z)</synopsis>
-        <synopsis>comet3d(x,y,z)</synopsis>
-        <synopsis>comet3d(x,y,fun)</synopsis>
-        <synopsis>comet3d(x,y,z,p)</synopsis>
-        <synopsis>comet3d(x,y,fun,p)</synopsis>
-        <synopsis>comet3d(...,"colors",c)</synopsis>
+        <synopsis>
+           comet3d(z)
+           comet3d(x, y, z)
+           comet3d(x, y, fun)
+           comet3d(x, y, z, p)
+           comet3d(x, y, fun, p)
+           comet3d(...,"colors", c)
+        </synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Parameters</title>
index 71d36ed..e9e47cc 100644 (file)
@@ -1,14 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
-
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
-
  * Copyright (C) Serge Steer
-
- * 
-
-
+ *
  * Copyright (C) 2012 - 2016 - Scilab Enterprises
  *
  * This file is hereby licensed under the terms of the GNU GPL v2.0,
  * and continues to be available under such terms.
  * For more information, see the COPYING file which you should have received
  * along with this program.
-
 -->
-
 <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="ja" xml:id="comet">
-    
     <refnamediv>
-        
         <refname>comet</refname>
-        
         <refpurpose>2次元 comet アニメーションプロット. </refpurpose>
-        
     </refnamediv>
-    
     <refsynopsisdiv>
-        
         <title>呼び出し手順</title>
-        
-        <synopsis>comet(y)</synopsis>
-        
-        <synopsis>comet(x,y)</synopsis>
-        
-        <synopsis>comet(x,fun)</synopsis>
-        
-        <synopsis>comet(x,y,p)</synopsis>
-        
-        <synopsis>comet(x,fun,p)</synopsis>
-        
-        <synopsis>comet(...,"colors",c)</synopsis>
-        
+        <synopsis>
+           comet(y)
+           comet(x,y)
+           comet(x,fun)
+           comet(x,y,p)
+           comet(x,fun,p)
+           comet(...,"colors",c)
+        </synopsis>
     </refsynopsisdiv>
-    
     <refsection>
-        
         <title>パラメータ</title>
-        
         <variablelist>
-            
             <varlistentry>
-                
                 <term>x</term>
-                
                 <listitem>
-                    
                     <para>
-                        
                         実数ベクトルまたは行列. 省略された場合,
-                        
                         ベクトル <literal>1:ny</literal> が指定されたと仮定されます.
-                        
                         ただし,<literal>ny</literal> は曲線の点の数(下記参照)です.
-                        
                     </para>
-                    
                 </listitem>
-                
             </varlistentry>
-            
             <varlistentry>
-                
                 <term>y</term>
-                
                 <listitem>
-                    
                     <para>
-                        
                         長さの実数ベクトルまたは行列.
-                        
                     </para>
-                    
                 </listitem>
-                
             </varlistentry>
-            
             <varlistentry>
-                
                 <term>p</term>
-                
                 <listitem>
-                    
                     <para>
-                        
                         範囲 <literal>[0 1[</literal> の実数スカラー.
-                        
                         デフォルト値は 0.1です.
-                        
                     </para>
-                    
                 </listitem>
-                
             </varlistentry>
-            
             <varlistentry>
-                
                 <term>fun</term>
-                
                 <listitem>
-                    
                     <para>
-                        
                         呼び出し手順  <literal>y=fun(x)</literal> のScilab関数.
-                        
                         <varname>fun</varname> は多項式または有理数とすることもできます.
-                        
                     </para>
-                    
                 </listitem>
-                
             </varlistentry>
-            
             <varlistentry>
-                
                 <term>c</term>
-                
                 <listitem>
-                    
                     <para>
-                        
                         <literal>ny</literal> 色添字のベクトル.
-                        
                     </para>
-                    
                 </listitem>
-                
             </varlistentry>
-            
         </variablelist>
-        
     </refsection>
-    
     <refsection>
-        
         <title>説明</title>
-        
         <para>
-            
             <literal>(x,y)</literal> が同じ要素数のベクトルの場合,
-            
             この関数は,
-            
             <literal>k</literal>を<literal>1</literal> から
-            
             <literal>size(x,'*')</literal>まで変えて
-            
             曲線<literal>(x(1:k),y(1:k))</literal>の漸進を示す
-            
             2次元アニメーションプロットを描画します.
-            
         </para>
-        
         <para>
-            
             このプロットは以下の3つの部分から構成されます:
-            
             <variablelist>
-                
                 <varlistentry>
-                    
-                    <term>ヘッド</term> 
-                    
+                    <term>ヘッド</term>
                     <listitem>
-                        
-                        <para>                        
-                            
+                        <para>
                             カレントの位置<literal>(x(i),y(i))</literal>を示すマーカ.
-                            
                         </para>
-                        
                     </listitem>
-                    
                 </varlistentry>
-                
                 <varlistentry>
-                    
                     <term>ボディ</term>
-                    
                     <listitem>
-                        
-                        <para> 
-                            
+                        <para>
                             ヘッドにつらなる曲線を表示します:曲線の一部
-                            
                             <literal>(x(i-k:i),y(i-k:i))</literal>.
-                            
                         </para>
-                        
                     </listitem>
-                    
                 </varlistentry>
-                
                 <varlistentry>
-                    
                     <term>テール</term>
-                    
                     <listitem>
-                        
                         <para>
-                            
                             曲線の<literal>(x(1:i-k),y(1:i-k))</literal>の部分を表示.
-                            
                         </para>
-                        
                     </listitem>
-                    
                 </varlistentry>
-                
             </variablelist>
-            
             <para>
-                
                 <literal>comet(x,fun,...)</literal>  は, <literal>comet(x,feval(x,fun),...)</literal> と等価です.
-                
             </para>
-            
             <para>
-                
                 <literal>comet(...,p)</literal> はボディの相対的な長さを設定する
-                
                 際に使用することができます.
-                
                 <literal>k</literal> は
-                
                 <literal>k = round(p*ny)</literal>のように定義できます.
-                
             </para>
-            
             <para>
-                
                 <varname>y</varname> が行列の場合,
-                
                 曲線のアニメーション表示が,
-                
                 <literal>(x,y(:,l))</literal>の各組について描画されます.
-                
                 この場合, <literal>ny</literal> は<varname>y</varname>の
-                
                 行の数です.
-                
             </para>
-            
             <para>
-                
                 <varname>x</varname> および <varname>y</varname> は
-                
                 同じ大きさの行列の場合,
-                
                 各組  <literal>(x(:,l),y(:,l))</literal> 毎に.
-                
                 アニメーション表示された曲線が描画されます.
-                
                 この場合, <literal>ny</literal>は
-                
                 <varname>x</varname>および  <varname>y</varname>の
-                
                 行の数です.
-                
             </para>
-            
-            
-            
             <para>
-                
                 <literal>comet(...,"colors",c)</literal> は
-                
                 各曲線の色を設定する際に使用できます.
-                
             </para>
-            
         </para>
-        
     </refsection>
-    
     <refsection>
-        
         <title>例</title>
-        
         <programlisting role="example"><![CDATA[
-
 t = linspace(0,10*%pi,500);
-
 clf();set(gca(),"isoview","on"); // 等軸に設定
-
 comet(t.*sin(t),t.*cos(t))
-
     ]]></programlisting>
-        
-        
-        
         <programlisting role="example"><![CDATA[
-
 t = linspace(0,10*%pi,500)';
-
 clf();comet(t.*sin(t),[t.*sin(2*t) t.*sin(3*t)])
-
     ]]></programlisting>
-        
         <programlisting role="example"><![CDATA[
-
 t = linspace(0,10*%pi,500)';
-
 clf();comet(t.*sin(t),[t.*sin(2*t) t.*sin(3*t)],"colors",[3 5])
-
     ]]></programlisting>
-        
         <programlisting role="example"><![CDATA[
-
 function y=traj(x),y=1.5*sin(x^2),endfunction
-
 clf();comet(linspace(0,5,500),traj)
-
     ]]></programlisting>
-        
         <programlisting role="example"><![CDATA[
-
 clf();comet(linspace(-2,4,500),(%s-3)/(%s^3+2*%s^2+1))
-
     ]]></programlisting>
-        
     </refsection>
-    
     <refsection>
-        
         <title>参照</title>
-        
         <simplelist type="inline">
-            
             <member>
-                
                 <link linkend="color">color</link>
-                
             </member>
-            
             <member>
-                
                 <link linkend="comet3d">comet3d</link>
-                
             </member>
-            
             <member>
-                
                 <link linkend="paramfplot2d">paramfplot2d</link>
-                
             </member>
-            
         </simplelist>
-        
     </refsection>
-    
     <refsection>
-        
         <title>履歴</title>
-        
         <revhistory>
-            
             <revision>
-                
                 <revnumber>5.3.2</revnumber>
-                
                 <revremark>
-                    
                     関数 <function>comet</function> が導入されました.
-                    
                 </revremark>
-                
             </revision>
-            
         </revhistory>
-        
     </refsection>
-    
-</refentry>
-
-
-
+</refentry>
\ No newline at end of file
index a75f4d1..5462fd6 100644 (file)
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
-
  * Add some comments about XML 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="ja" xml:id="comet3d">
-    
     <refnamediv>
-        
         <refname>comet3d</refname>
-        
         <refpurpose>3次元 comet アニメーションプロット. </refpurpose>
-        
     </refnamediv>
-    
     <refsynopsisdiv>
-        
         <title>呼び出し手順</title>
-        
-        <synopsis>comet3d(z)</synopsis>
-        
-        <synopsis>comet3d(x,y,z)</synopsis>
-        
-        <synopsis>comet3d(x,y,fun)</synopsis>
-        
-        <synopsis>comet3d(x,y,z,p)</synopsis>
-        
-        <synopsis>comet3d(x,y,fun,p)</synopsis>
-        
-        <synopsis>comet3d(...,"colors",c)</synopsis>
-        
+        <synopsis>
+           comet3d(z)
+           comet3d(x, y, z)
+           comet3d(x, y, fun)
+           comet3d(x, y, z, p)
+           comet3d(x, y, fun, p)
+           comet3d(...,"colors", c)
+        </synopsis>
     </refsynopsisdiv>
-    
     <refsection>
-        
         <title>パラメータ</title>
-        
         <variablelist>
-            
             <varlistentry>
-                
                 <term>x</term>
-                
                 <listitem>
-                    
                     <para>
-                        
                         実数ベクトルまたは行列. 省略された場合,
-                        
                         ベクトル  <literal>1:nz</literal> が使用されます.
-                        
                         ただし,  <literal>nz</literal> は<literal>z</literal>パラメータ
-                        
                         で指定される曲線の点の数です.
-                        
                     </para>
-                    
                 </listitem>
-                
             </varlistentry>
-            
             <varlistentry>
-                
                 <term>y</term>
-                
                 <listitem>
-                    
                     <para>
-                        
                         実数ベクトルまたは行列. 省略された場合,
-                        
                         ベクトル  <literal>1:nz</literal> が使用されます.
-                        
                         ただし,  <literal>nz</literal> は<literal>z</literal>パラメータ
-                        
                         で指定される曲線の点の数です.
-                        
                     </para>
-                    
                 </listitem>
-                
             </varlistentry>
-            
             <varlistentry>
-                
                 <term>z</term>
-                
                 <listitem>
-                    
                     <para>
-                        
                         長さ <literal>nz</literal> の実数ベクトル, または,
-                        
                         <literal>nz</literal> 行の行列.
-                        
                     </para>
-                    
                 </listitem>
-                
             </varlistentry>
-            
             <varlistentry>
-                
                 <term>p</term>
-                
                 <listitem>
-                    
                     <para>
-                        
                         範囲 <literal>[0 1[</literal> の実数スカラー.
-                        
                         デフォルト値は 0.1.
-                        
                     </para>
-                    
                 </listitem>
-                
             </varlistentry>
-            
             <varlistentry>
-                
                 <term>fun</term>
-                
                 <listitem>
-                    
                     <para>
-                        
                         呼び出し手順 <literal>z=fun(x,y)</literal> のScilab関数.
-                        
                     </para>
-                    
                 </listitem>
-                
             </varlistentry>
-            
             <varlistentry>
-                
                 <term>c</term>
-                
                 <listitem>
-                    
                     <para>
-                        
                         <literal>ny</literal> 色の添字のベクトル.
-                        
                     </para>
-                    
                 </listitem>
-                
             </varlistentry>
-            
         </variablelist>
-        
     </refsection>
-    
     <refsection>
-        
         <title>説明</title>
-        
         <para>
-            
             <literal>(x,y,z)</literal>が要素数が同じ3つのベクトルの場合,
-            
             この関数は3次元cometアニメーションプロットを描画します.
-            
             このプロットは以下の3つの部分から構成されます:
-            
             <variablelist>
-                
                 <varlistentry>
-                    
                     <term>ヘッド</term>
-                    
                     カレントの位置<literal>(x(i),y(i),z(i))</literal>を示すマーカ.
-                    
                     <listitem><para>
-                            
                         </para>
-                        
                     </listitem>
-                    
                 </varlistentry>
-                
                 <varlistentry>
-                    
                     <term>ボディー</term> ヘッドに続く尾の曲線を示す:
-                    
                     曲線の一部
-                    
                     <literal>(x(i-k:i),y(i-k:i),z(i-k:i))</literal>) 
-                    
                     <listitem><para>
-                            
                         </para>
-                        
                     </listitem>
-                    
                 </varlistentry>
-                
                 <varlistentry>
-                    
                     <term>テール</term> 
-                    
                     曲線の一部<literal>(x(1:i-k),y(1:i-k),z(1:i-k))</literal> を示す.
-                    
                     <listitem><para>
-                            
                         </para>
-                        
                     </listitem>
-                    
                 </varlistentry>
-                
             </variablelist>
-            
             <para>
-                
                 <literal>z</literal> が行列,
-                
                 <literal>(x,y)</literal> がベクトルの場合,
-                
                 アニメーション表示される曲線は各<literal>(x,y,z(:,l))</literal>
-                
                 の組について描画されます.
-                
                 この場合,
-                
                 <literal>nz</literal> は <literal>z</literal>の行の数となります.
-                
             </para>
-            
             <para>
-                
                 <literal>x,y,z</literal> が同じ次元の行列の場合,
-                
                 アニメーション表示される曲線は,
-                
                 各組<literal>(x(:,l),y(:,l),z(:,l))</literal>について
-                
                 描画されます.
-                
             </para>
-            
-            
-            
             <para>
-                
                 <literal>comet3d(x,y,fun,...)</literal> は,
-                
                 <literal>z</literal> ベクトルを
-                
                 <literal>z(i)=fun(x(i),y(i))</literal>により
-                
                 計算します.
-                
             </para>
-            
             <para>
-                
                 <literal>comet3d(...,p)</literal> は,
-                
                 ボディの相対長を設定するために使用することができます.
-                
                 <literal>k</literal> は,
-                
                 <literal>k = round(p*nz)</literal>により定義されます.
-                
             </para>
-            
-            
-            
         </para>
-        
     </refsection>
-    
     <refsection>
-        
         <title>例</title>
-        
         <programlisting role="example"><![CDATA[
-
 t = linspace(-%pi,%pi,500);
-
 clf();comet3d(sin(5*t),sin(t),t^2)
-
     ]]></programlisting>
-        
         <programlisting role="example"><![CDATA[
-
 t = linspace(-%pi,%pi,500)';
-
 clf();comet3d(sin(5*t),sin(t),[t^2,ones(t)])
-
     ]]></programlisting>
-        
         <programlisting role="example"><![CDATA[
-
 t = linspace(-%pi,%pi,500)';
-
 function z=traj(x,y),z=1.5*sin(x^2)*cos(y),endfunction
-
 clf();comet3d(cos(t),sin(t),traj)
-
     ]]></programlisting>
-        
     </refsection>
-    
     <refsection>
-        
         <title>参照</title>
-        
         <simplelist type="inline">
-            
             <member>
-                
                 <link linkend="comet">comet</link>
-                
             </member>
-            
         </simplelist>
-        
     </refsection>
-    
     <refsection>
-        
         <title>履歴</title>
-        
         <revhistory>
-            
             <revision>
-                
                 <revnumber>5.3.2</revnumber>
-                
                 <revremark>関数 comet3d が導入されました.</revremark>
-                
             </revision>
-            
         </revhistory>
-        
     </refsection>
-    
-</refentry>
-
+</refentry>
\ No newline at end of file
index 9402bad..0627d8f 100644 (file)
     </refnamediv>
     <refsynopsisdiv>
         <title>Синтаксис</title>
-        <synopsis>comet(y)</synopsis>
-        <synopsis>comet(x, y)</synopsis>
-        <synopsis>comet(x, fun)</synopsis>
-        <synopsis>comet(x, y, p)</synopsis>
-        <synopsis>comet(x, fun, p)</synopsis>
-        <synopsis>comet(...,"colors",c)</synopsis>
+        <synopsis>
+           comet(y)
+           comet(x, y)
+           comet(x, fun)
+           comet(x, y, p)
+           comet(x, fun, p)
+           comet(...,"colors",c)
+        </synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Аргументы</title>
index f0cd445..de69d1d 100644 (file)
@@ -2,67 +2,79 @@
 <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="close">
     <refnamediv>
         <refname>close</refname>
-        <refpurpose>close a figure or a window</refpurpose>
+        <refpurpose>closes graphic figures, progressionbars or waitbars</refpurpose>
     </refnamediv>
-    <refsection>
+    <refsynopsisdiv>
+        <title>Syntax</title>
+        <synopsis>
+            close
+            close(H)
+        </synopsis>
+    </refsynopsisdiv>
+    <refsection role="parameters">
         <title>Arguments</title>
         <variablelist>
             <varlistentry>
-                <term>h</term>
+                <term>H</term>
                 <listitem>
-                    <para>integer Handle or window identification of the window to close.</para>
+                    <para>Handle or vector of handles of graphic figures or progression bar
+                        or wait bar. These different types of handles can be mixed in <varname>H</varname>.
+                    </para>
+                    <para>
+                        By default, the current graphic figure is considered.
+                    </para>
                 </listitem>
             </varlistentry>
         </variablelist>
     </refsection>
-    <refsection>
+    <refsection role="description">
         <title>Description</title>
-        <para>
-            This routine close a tksci figure (toplevel window). If a handle 
-            (resp. window identification) is given, the figure (resp. window)
-            corresponding to this handle (resp. window identification) is closed.
-            Otherwise, the current (active) figure is closed.
+        <para>Graphic windows based on the Tk technology (such as still used by imshow() in the SIVP
+            external module) may be closed as well by providing their number that is their handle.
         </para>
     </refsection>
-    <refsection>
+    <refsection role="examples">
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
-h=figure();
-// creates  figure number 1.  
+        <programlisting role="example"><![CDATA[
+// creates  figure number 1.
+h = scf();
+// put a clever text in figure 1
 uicontrol( h, 'style','text', ...
               'string','scilab is great', ...
               'position',[50 70 100 100], ...
               'fontsize',15);
-// put a clever text in figure 1
-figure();
 // create figure 2
+scf();
+// put a text in figure 2
 uicontrol( 'style','text', ...
            'string','Really great', 'position',[50 70 100 100], 'fontsize',15);
-// put a text in figure 2
-close();
-// close the current graphic window (ie fig. 2)
-close(h);
-// close figure 1
-wid1=progressionbar("Message");
+
+close();   // close the current graphic window (ie fig. 2)
+close(h);  // close figure 1
+
 // create a progression bar
+wid1=progressionbar("Message");
+// close it
 close(wid1);
-// close this window
  ]]></programlisting>
     </refsection>
     <refsection role="see also">
         <title>See Also</title>
         <simplelist type="inline">
             <member>
-                <link linkend="figure">figure</link>
+                <link linkend="xdel">xdel</link>
             </member>
             <member>
-                <link linkend="gcf">gcf</link>
+                <link linkend="delete">delete</link>
             </member>
             <member>
-                <link linkend="xdel">xdel</link>
+                <link linkend="figure">figure</link>
             </member>
             <member>
-                <link linkend="delete">delete</link>
+                <link linkend="scf">scf</link>
+            </member>
+            <member>
+                <link linkend="gcf">gcf</link>
             </member>
         </simplelist>
     </refsection>
index e7d1566..7f55b5f 100644 (file)
@@ -3,7 +3,8 @@
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2007 - INRIA - Allan CORNET
  * Copyright (C) 2007 - INRIA - Sylvestre LEDRU
- * 
+ * Copyright (C) 2016 - Samuel GOUGEON
+ *
  * Copyright (C) 2012 - 2016 - Scilab Enterprises
  *
  * This file is hereby licensed under the terms of the GNU GPL v2.0,
 <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="setlanguage">
     <refnamediv>
         <refname>setlanguage</refname>
-        <refpurpose>Changes the language of Scilab's user interface</refpurpose>
+        <refpurpose>chooses the language used for standard messages and help pages for the current session</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Syntax</title>
-        <synopsis>setlanguage(language)</synopsis>
+        <synopsis>TF = setlanguage(language)</synopsis>
     </refsynopsisdiv>
-    <refsection>
+    <refsection role="parameters">
         <title>Arguments</title>
         <variablelist>
             <varlistentry>
                 <term>language</term>
                 <listitem>
-                    <para>string made of a two-letter, lower-case, ISO Language Code, optionally followed by an underscore and a two-letter, upper-case, ISO country code), such as: 'fr', 'en', 'en_US', 'ru_RU', 'zh_TW'...</para>
+                    <para>single string among 'en', 'fr', 'ja', 'pt', 'ru', 'de', en_US', 'fr_FR',
+                        'ja_JP', 'pt_BR', 'ru_RU', 'de_DE', 'zh_TW'...
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>TF</term>
+                <listitem>
+                    <para>
+                        single boolean: <literal>%T</literal> if the setting has been actually
+                        performed, <literal>%F</literal> otherwise.
+                    </para>
                 </listitem>
             </varlistentry>
         </variablelist>
     </refsection>
-    <refsection>
+    <refsection role="description">
         <title>Description</title>
         <para>
-            <literal>setlanguage(language)</literal> changes the language used by Scilab user interface, including help, error messages, for the current execution of Scilab.
+            <literal>setlanguage(language)</literal> changes the language used for error or warning
+            messages or other standard words and texts such as the name of days and months, etc.
+            If their translation is available, help pages are also displayed in the chosen language,
+            after restarting the help browser.
         </para>
         <para>
-            <literal>setlanguage('')</literal> resets the language to the system value.
+            The chosen language applies only to the current Scilab session.
         </para>
         <para>
-            <literal>setlanguage</literal> works on all supported operating systems. 
+            <literal>setlanguage('')</literal> resets the language to the system value
+            <literal>"en_US"</literal> and returns <literal>%F</literal>.
         </para>
+        <para>
+            <literal>setlanguage</literal> works on all supported operating systems.
+        </para>
+        <warning>The new language is not taken into account in the menus of interfaces (help browser,
+            variables browser, code editor, etc). No menus translation is done neither "on-the-flight"
+            nor after reopening the interfaces. To set the language used in the menus, please use
+            <literal>setdefaultlanguage(..)</literal> instead.
+        </warning>
     </refsection>
-    <refsection>
+    <refsection role="examples">
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
-setlanguage('en_US')
-getlanguage()
-setlanguage('en')
-getlanguage()
-setlanguage('fr')
-getlanguage()
-setlanguage('fr_FR')
-getlanguage()
+        <programlisting role="example"><![CDATA[
+L = getlanguage();
+
+// Translated strings
+setlanguage ja;
+_ Monday
+setlanguage pt_BR;
+_ Monday
+setlanguage ru;
+_ July
+
+// Error messages:
+setlanguage en;
+linspace("") // to yield and display an error message
+setlanguage ja;
+linspace("")
+setlanguage ru;
+linspace("")
+
+help linspace // the page should appear in Russian (if the help browser was closed)
+
+// Restoring the initial language
+setlanguage(L)
  ]]></programlisting>
     </refsection>
     <refsection role="see also">
         <title>See Also</title>
         <simplelist type="inline">
             <member>
+                <link linkend="setdefaultlanguage">setdefaultlanguage</link>
+            </member>
+            <member>
                 <link linkend="getlanguage">getlanguage</link>
             </member>
             <member>
-                <link linkend="setdefaultlanguage">setdefaultlanguage</link>
+                <link linkend="gettext">gettext</link>
             </member>
         </simplelist>
     </refsection>
index d8de7af..ffb769f 100644 (file)
@@ -1,12 +1,27 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2007 - INRIA - Allan CORNET
+ * Copyright (C) 2016 - Samuel GOUGEON
+ *
+ * Copyright (C) 2012 - 2016 - Scilab Enterprises
+ *
+ * This file is hereby licensed under the terms of the GNU GPL v2.0,
+ * pursuant to article 5.3.4 of the CeCILL v.2.1.
+ * This file was originally licensed under the terms of the CeCILL v2.1,
+ * and continues to be available under such terms.
+ * For more information, see the COPYING file which you should have received
+ * along with this program.
+ *
+ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="setlanguage" xml:lang="fr">
     <refnamediv>
         <refname>setlanguage</refname>
-        <refpurpose>Modifie la langue courante.</refpurpose>
+        <refpurpose>choisit la langue utilisée pour les messages standard et les pages d'aide (session en cours)</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Séquence d'appel</title>
-        <synopsis>setlanguage(language)</synopsis>
+        <synopsis>TF = setlanguage(language)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Paramètres</title>
             <varlistentry>
                 <term>language</term>
                 <listitem>
-                    <para>avec language='fr' or 'en'</para>
+                    <para>single string among 'en', 'fr', 'ja', 'pt', 'ru', 'de', en_US', 'fr_FR',
+                      'ja_JP', 'pt_BR', 'ru_RU', 'de_DE', 'zh_TW'...
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>TF</term>
+                <listitem>
+                    <para>booléen unique : <literal>%T</literal> si la langue indiquée a bien été
+                      affectée comme nouvelle langue d'usage, <literal>%F</literal> sinon.
+                    </para>
                 </listitem>
             </varlistentry>
         </variablelist>
     </refsection>
-    <refsection>
+    <refsection role="description">
         <title>Description</title>
         <para>
-            <literal>setlanguage(language)</literal> change la langue courante
-            dans scilab.
+            <literal>setlanguage(language)</literal> change la langue utilisée pour les messages
+          standard d'alerte ou d'erreur, ou pour d'autres mots standard tels que le nom des jours
+          ou des mois, etc.
+          Lorsqu'une version traduite est disponible, les pages d'aide sont également affichées
+          dans la langue choisie, après redémarrage du navigateur d'aide.
+        </para>
+        <para>
+            La langue choisie persiste uniquement pour la session Scilab en cours.
         </para>
-        <para>et sauvegarde celle-ci.</para>
-        <para>un redemarrage de scilab est necessaire pour que les menus soient
-            localisés.
+        <para>
+            <literal>setlanguage('')</literal> réinitialise la langue à la langue de référence "en_US".
         </para>
+        <para>
+            <literal>setlanguage</literal> est utilisable sur tous les systèmes d'exploitation
+             supportés par Scilab.
+        </para>
+        <warning>La nouvelle langue n'est pas utilisée dans les menus des interfaces (navigateur
+          d'aide, navigateur de variables, éditeur de code Scilab, etc). Aucune traduction des menus
+          n"est effectuée ni à la volée ni après avoir réouvert les interfaces pour actualisation.
+          Les menus sont toujours traduits dans la langue par défaut de la session Scilab (celle
+          utilisée à l'ouverture de la session). Celle-ci peut être modifiée avec
+          <literal>setdefaultlanguage(..)</literal>.
+        </warning>
+    </refsection>
+    <refsection role="examples">
+        <title>Exemples</title>
+        <programlisting role="example"><![CDATA[
+L = getlanguage();
+
+// Mots et expressions standard
+setlanguage ja;
+_ Monday
+setlanguage pt_BR;
+_ Monday
+setlanguage ru;
+_ July
+
+// Error messages:
+setlanguage en;
+linspace("") // pour générer un message d'erreur
+setlanguage ja;
+linspace("")
+setlanguage ru;
+linspace("")
+
+help linspace // la page doit apparaitre en Russe (si le navigateur a été réouvert)
+
+// Rétablissement de la langue initiale
+setlanguage(L)
+ ]]></programlisting>
     </refsection>
     <refsection role="see also">
         <title>Voir aussi</title>
         <simplelist type="inline">
             <member>
+                <link linkend="setdefaultlanguage">setdefaultlanguage</link>
+            </member>
+            <member>
                 <link linkend="getlanguage">getlanguage</link>
             </member>
+            <member>
+                <link linkend="gettext">gettext</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
diff --git a/scilab/modules/localization/help/ja_JP/setlanguage.xml b/scilab/modules/localization/help/ja_JP/setlanguage.xml
deleted file mode 100644 (file)
index 7e7b3cf..0000000
+++ /dev/null
@@ -1,117 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<!--
- * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
- * Copyright (C) 2007 - INRIA - Allan CORNET
- * Copyright (C) 2007 - INRIA - Sylvestre LEDRU
- * 
- * Copyright (C) 2012 - 2016 - Scilab Enterprises
- *
- * This file is hereby licensed under the terms of the GNU GPL v2.0,
- * pursuant to article 5.3.4 of the CeCILL v.2.1.
- * This file was originally licensed under the terms of the CeCILL v2.1,
- * and continues to be available under such terms.
- * For more information, see the COPYING file which you should have received
- * along with this program.
- *
- -->
-
-<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="ja" xml:id="setlanguage">
-    
-    <refnamediv>
-        
-        <refname>setlanguage</refname>
-        
-        <refpurpose>
-            
-            内部変数 LANGUAGE の値を設定(Windows専用)
-            
-        </refpurpose>
-        
-    </refnamediv>
-    
-    <refsynopsisdiv>
-        
-        <title>呼び出し手順</title>
-        
-        <synopsis>setlanguage(language)</synopsis>
-        
-    </refsynopsisdiv>
-    
-    <refsection>
-        
-        <title>引数</title>
-        
-        <variablelist>
-            
-            <varlistentry>
-                
-                <term>language</term>
-                
-                <listitem>
-                    
-                    <para>language='fr' または  'en', ... と指定</para>
-                    
-                </listitem>
-                
-            </varlistentry>
-            
-        </variablelist>
-        
-    </refsection>
-    
-    <refsection>
-        
-        <title>説明</title>
-        
-        <para>
-            
-            <literal>setlanguage(language)</literal> は, Scilabの
-            
-            カレントの言語を変更します.
-            
-        </para>
-        
-    </refsection>
-    
-    <refsection>
-        
-        <title>例</title>
-        
-        <programlisting role="example"><![CDATA[ 
-setlanguage('en_US')
-getlanguage()
-setlanguage('en')
-getlanguage()
-setlanguage('fr')
-getlanguage()
-setlanguage('fr_FR')
-getlanguage()
- ]]></programlisting>
-        
-    </refsection>
-    
-    <refsection role="see also">
-        
-        <title>参照</title>
-        
-        <simplelist type="inline">
-            
-            <member>
-                
-                <link linkend="getlanguage">getlanguage</link>
-                
-            </member>
-            
-            <member>
-                
-                <link linkend="setdefaultlanguage">setdefaultlanguage</link>
-                
-            </member>
-            
-        </simplelist>
-        
-    </refsection>
-    
-</refentry>
-
diff --git a/scilab/modules/localization/help/ru_RU/setlanguage.xml b/scilab/modules/localization/help/ru_RU/setlanguage.xml
deleted file mode 100644 (file)
index 606f77b..0000000
+++ /dev/null
@@ -1,69 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
- * Copyright (C) 2007 - INRIA - Allan CORNET
- * Copyright (C) 2007 - INRIA - Sylvestre LEDRU
- * 
- * Copyright (C) 2012 - 2016 - Scilab Enterprises
- *
- * This file is hereby licensed under the terms of the GNU GPL v2.0,
- * pursuant to article 5.3.4 of the CeCILL v.2.1.
- * This file was originally licensed under the terms of the CeCILL v2.1,
- * and continues to be available under such terms.
- * For more information, see the COPYING file which you should have received
- * along with this program.
- *
- -->
-<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="ru" xml:id="setlanguage">
-    <refnamediv>
-        <refname>setlanguage</refname>
-        <refpurpose>
-            установка значения внутреннего языка LANGUAGE
-        </refpurpose>
-    </refnamediv>
-    <refsynopsisdiv>
-        <title>Синтаксис</title>
-        <synopsis>setlanguage(language)</synopsis>
-    </refsynopsisdiv>
-    <refsection>
-        <title>Аргументы</title>
-        <variablelist>
-            <varlistentry>
-                <term>language</term>
-                <listitem>
-                    <para>строка, указывающая язык 'fr', 'en', 'ru_RU', 'zh_TW' и др. </para>
-                </listitem>
-            </varlistentry>
-        </variablelist>
-    </refsection>
-    <refsection>
-        <title>Описание</title>
-        <para>
-            <literal>setlanguage(language)</literal> меняет текущий язык в Scilab.
-        </para>
-    </refsection>
-    <refsection>
-        <title>Примеры</title>
-        <programlisting role="example"><![CDATA[ 
-setlanguage('en_US')
-getlanguage()
-setlanguage('en')
-getlanguage()
-setlanguage('fr')
-getlanguage()
-setlanguage('fr_FR')
-getlanguage()
- ]]></programlisting>
-    </refsection>
-    <refsection role="see also">
-        <title>Смотрите также</title>
-        <simplelist type="inline">
-            <member>
-                <link linkend="getlanguage">getlanguage</link>
-            </member>
-            <member>
-                <link linkend="setdefaultlanguage">setdefaultlanguage</link>
-            </member>
-        </simplelist>
-    </refsection>
-</refentry>
index 34ecb5a..c7cb265 100644 (file)
@@ -128,6 +128,7 @@ plot2d()
 // [If you are a MacOS user, select the menu "Edit=> Clear figure" instead]
 mprintf("During this 30s sleep, click on the figure\n  then on its menu ""Edit => Figure properties""")
 // The graphical editor will be actually called only at wake-up
+sleep(30, "s")
  ]]></programlisting>
     </refsection>
     <refsection role="see also">
index db8a761..20ce54a 100644 (file)
@@ -133,6 +133,7 @@ plot2d()
 // [Si vous êtes utilisateur MacOS, choisir le menu "Editer => Effacer la figure"]
 mprintf("Pendant ce sommeil de 30s, cliquer sur la fenêtre graphique,\n   puis menu Editer => Propriétés de la Figure")
 // L'éditeur de propriétés graphiques sera appelé uniquement au réveil de Scilab
+sleep(30, "s")
  ]]></programlisting>
     </refsection>
     <refsection role="see also">