[doc] misc. fix & improvements 77/20877/49
Samuel GOUGEON [Fri, 22 Feb 2019 14:11:29 +0000 (15:11 +0100)]
  * JKFLIPFLOP_content: useless after https://codereview.scilab.org/20745
  * dct: typo fixed: http://bugzilla.scilab.org/15982
  * chdir: b not documented in (fr): http://bugzilla.scilab.org/10882
           + improvements: default path, + <screen>, see also.
  * convol2d: result's length error fixed: http://bugzilla.scilab.org/16042
  * stdev (en) typo : http://bugzilla.scilab.org/16099
  * backslash: history version fixed.
  * lcm.xm: removed. Bad extension. Duplicate of lcm.xml
  * name2rgb: + names are case insensitive.
  * m2scideclare: one useless itemizedlist level suppressed.
                  Examples: required \n added.
  * SCIHOME, startup: See also: extra <simplelist> removed
  * gettext: protect \n in some samples of the table of syntaxes.
     + remark % blanks delimiting messages id in XML and XSL.
  * SP/Howto chapter: empty section removed (fr,ja)
  * exp (fr): the input matrix does not need to be square.
  * calendar:
    - fix c = calendar => c = calendar()
    - fix "from sunday to saturday" => "from monday to sunday"
    - fix shifted translations of days series.
    - examples extended and illustrated.

Change-Id: Ib875d0268129be395456b103453d64668029f52a

85 files changed:
scilab/modules/console/help/en_US/console.xml
scilab/modules/console/help/ru_RU/console.xml
scilab/modules/core/help/en_US/1_keywords/backslash.xml
scilab/modules/core/help/en_US/startup.xml
scilab/modules/core/help/en_US/variables/predefined/SCIHOME.xml
scilab/modules/core/help/fr_FR/1_keywords/backslash.xml
scilab/modules/core/help/fr_FR/1_keywords/plus.xml
scilab/modules/core/help/fr_FR/startup.xml
scilab/modules/core/help/ja_JP/1_keywords/backslash.xml
scilab/modules/core/help/ja_JP/startup.xml
scilab/modules/core/help/ja_JP/variables/predefined/SCIHOME.xml
scilab/modules/core/help/pt_BR/1_keywords/backslash.xml
scilab/modules/core/help/pt_BR/startup.xml
scilab/modules/core/help/ru_RU/1_keywords/backslash.xml
scilab/modules/core/help/ru_RU/scilab.xml
scilab/modules/core/help/ru_RU/startup.xml
scilab/modules/core/help/ru_RU/variables/predefined/SCIHOME.xml
scilab/modules/coverage/help/fr_FR/addchapter.sce
scilab/modules/elementary_functions/help/en_US/exponential/log2.xml
scilab/modules/elementary_functions/help/en_US/setoperations/setdiff.xml
scilab/modules/elementary_functions/help/en_US/trigonometry/atanh.xml
scilab/modules/elementary_functions/help/fr_FR/elementarymatrices/linspace.xml
scilab/modules/elementary_functions/help/fr_FR/exponential/exp.xml
scilab/modules/elementary_functions/help/fr_FR/exponential/log2.xml
scilab/modules/elementary_functions/help/ru_RU/discrete/lcm.xml
scilab/modules/elementary_functions/help/ru_RU/exponential/log2.xml
scilab/modules/elementary_functions/help/ru_RU/setoperations/setdiff.xml
scilab/modules/external_objects_java/help/en_US/01-getting-started.xml
scilab/modules/external_objects_java/help/en_US/02-getting-started.xml
scilab/modules/external_objects_java/help/ja_JP/01-getting-started.xml
scilab/modules/external_objects_java/help/ja_JP/02-getting-started.xml
scilab/modules/fileio/help/en_US/directory/chdir.xml
scilab/modules/fileio/help/fr_FR/directory/chdir.xml
scilab/modules/fileio/help/ja_JP/directory/chdir.xml
scilab/modules/fileio/help/pt_BR/directory/chdir.xml
scilab/modules/fileio/help/ru_RU/directory/chdir.xml
scilab/modules/graphics/help/en_US/color_management/colorbar.xml
scilab/modules/graphics/help/en_US/color_management/name2rgb.xml
scilab/modules/graphics/help/en_US/datatips/datatips.xml
scilab/modules/graphics/help/en_US/object_editor.xml
scilab/modules/graphics/help/fr_FR/object_editor.xml
scilab/modules/graphics/help/ja_JP/color_management/name2rgb.xml
scilab/modules/graphics/help/ja_JP/datatips/datatips.xml
scilab/modules/graphics/help/ja_JP/object_editor.xml
scilab/modules/graphics/help/pt_BR/color_management/name2rgb.xml
scilab/modules/graphics/help/pt_BR/object_editor.xml
scilab/modules/gui/help/en_US/interactive_editor.xml
scilab/modules/gui/help/ja_JP/interactive_editor.xml
scilab/modules/gui/help/pt_BR/interactive_editor.xml
scilab/modules/localization/help/en_US/addchapter.sce
scilab/modules/localization/help/en_US/gettext.xml
scilab/modules/localization/help/fr_FR/addchapter.sce
scilab/modules/m2sci/help/en_US/About_M2SCI_tools.xml
scilab/modules/m2sci/help/en_US/m2sci_equivalents/h/horzcat.xml
scilab/modules/m2sci/help/en_US/m2sci_equivalents/i/isa.xml
scilab/modules/m2sci/help/en_US/m2sci_equivalents/r/randperm.xml
scilab/modules/m2sci/help/en_US/m2sci_equivalents/v/vertcat.xml
scilab/modules/m2sci/help/en_US/m2scideclare.xml
scilab/modules/m2sci/help/fr_FR/m2scideclare.xml
scilab/modules/modules_manager/help/en_US/sections_builders/tbx_builder_macros.xml
scilab/modules/modules_manager/help/fr_FR/addchapter.sce
scilab/modules/scinotes/help/en_US/scinotes.xml
scilab/modules/scinotes/help/ja_JP/scinotes.xml
scilab/modules/signal_processing/help/en_US/correlation_convolution/convol2d.xml
scilab/modules/signal_processing/help/en_US/transforms/dct.xml
scilab/modules/signal_processing/help/fr_FR/howto/CHAPTER [deleted file]
scilab/modules/signal_processing/help/ja_JP/correlation_convolution/convol2d.xml
scilab/modules/signal_processing/help/ja_JP/howto/CHAPTER [deleted file]
scilab/modules/signal_processing/help/ja_JP/transforms/dct.xml
scilab/modules/sound/help/en_US/playsnd.xml
scilab/modules/sound/help/ja_JP/playsnd.xml
scilab/modules/statistics/help/en_US/3_dispersion_widths/stdev.xml
scilab/modules/string/help/en_US/sci2exp.xml
scilab/modules/time/help/en_US/calendar.xml
scilab/modules/time/help/fr_FR/addchapter.sce
scilab/modules/time/help/fr_FR/calendar.xml
scilab/modules/time/help/ja_JP/calendar.xml
scilab/modules/time/locales/fr_FR.po
scilab/modules/time/locales/ja_JP.po
scilab/modules/time/locales/pt_BR.po
scilab/modules/time/locales/ru_RU.po
scilab/modules/webtools/help/fr_FR/addchapter.sce
scilab/modules/xcos/help/en_US/palettes/Integer_pal/JKFLIPFLOP_content.dbk [deleted file]
scilab/modules/xml/help/en_US/xmlXPath.xml
scilab/modules/xml/help/ja_JP/xmlXPath.xml

index 5198a09..0ee9627 100644 (file)
@@ -341,6 +341,9 @@ prefs general/shortcuts;
         <title>See Also</title>
         <simplelist type="inline">
             <member>
+                <link linkend="scinotes_menus_shortcuts">editor shortcuts</link>
+            </member>
+            <member>
                 <link linkend="preferences">preferences</link>
             </member>
             <member>
index 7620bf8..4fc4b32 100644 (file)
@@ -344,6 +344,9 @@ prefs general/shortcuts;
         <title>Смотрите также</title>
         <simplelist type="inline">
             <member>
+                <link linkend="scinotes_menus_shortcuts">Ярлыки редактора</link>
+            </member>
+            <member>
                 <link linkend="preferences">настройки</link>
             </member>
             <member>
index 2d2a161..a6f4e84 100644 (file)
@@ -142,7 +142,7 @@ mprintf('\ntime with backslash: %.3f\n',toc());
         <title>History</title>
         <revhistory>
             <revision>
-                <revnumber>5.4.1</revnumber>
+                <revnumber>5.5.0</revnumber>
                 <revremark>
                   The threshold level which switches between Gaussian Elimination with row pivoting
                   and linear least squares when computing A\B is decreased from sqrt(eps) to eps.
index 0a5ed76..62b3043 100644 (file)
@@ -1,5 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<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="startup" xml:lang="en">
+<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="startup" xml:lang="en">
     <refnamediv>
         <refname>startup</refname>
         <refpurpose>startup files</refpurpose>
@@ -35,18 +38,12 @@ end
             <member>
                 <link linkend="scilab">scilab</link>
             </member>
-        </simplelist>
-        <simplelist type="inline">
             <member>
                 <link linkend="SCIHOME">SCIHOME</link>
             </member>
-        </simplelist>
-        <simplelist type="inline">
             <member>
                 <link linkend="SCI">SCI</link>
             </member>
-        </simplelist>
-        <simplelist type="inline">
             <member>
                 <link linkend="TMPDIR">TMPDIR</link>
             </member>
index c53f694..72595ac 100644 (file)
@@ -69,13 +69,9 @@ isdir(SCIHOME)
             <member>
                 <link linkend="SCI">SCI</link>
             </member>
-        </simplelist>
-        <simplelist type="inline">
             <member>
                 <link linkend="TMPDIR">TMPDIR</link>
             </member>
-        </simplelist>
-        <simplelist type="inline">
             <member>
                 <link linkend="scilab">Scilab startup</link>
             </member>
index f1d99ca..592bfc9 100644 (file)
@@ -90,7 +90,7 @@ mprintf('\ntemps nécessaire à la résolution du système avec l''opérateur ba
         <title>Historique</title>
         <revhistory>
             <revision>
-                <revnumber>5.4.1</revnumber>
+                <revnumber>5.5.0</revnumber>
                 <revremark>
                   The threshold level which switches between Gaussian Elimination with row pivoting
                   and linear least squares when computing A\B is decreased from sqrt(eps) to eps.
index d4585cb..6dc323b 100644 (file)
  ans  =
 !concatenate  concrete  console  !
 ]]></screen>
-    <para>Avec des booléeens :</para>
+    <para>Avec des booléens :</para>
         <programlisting role="example"><![CDATA[
 [%f %f %t %t] + [%f %t %f %t]
 %f + [-1 0 2 %i]
index 6b49c42..a58d875 100644 (file)
@@ -1,5 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="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="startup" xml:lang="fr">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="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="startup" xml:lang="fr">
     <refnamediv>
         <refname>startup</refname>
         <refpurpose>startup file</refpurpose>
             <member>
                 <link linkend="scilab">scilab</link>
             </member>
-        </simplelist>
-        <simplelist type="inline">
             <member>
                 <link linkend="SCIHOME">SCIHOME</link>
             </member>
-        </simplelist>
-        <simplelist type="inline">
             <member>
                 <link linkend="SCI">SCI</link>
             </member>
-        </simplelist>
-        <simplelist type="inline">
             <member>
                 <link linkend="TMPDIR">TMPDIR</link>
             </member>
index 41f9b05..92fd40f 100644 (file)
@@ -1,6 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
-<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="backslash">
+<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="backslash">
     
     <refnamediv>
         
@@ -236,7 +239,7 @@ mprintf('\ntime with backslash: %.3f\n',toc());
             
             <revision>
                 
-                <revnumber>5.4.1</revnumber>
+                <revnumber>5.5.0</revnumber>
                 
                 <revremark>バックスラッシュの条件数の閾値が増加しました.</revremark>
                 
index e109fe0..a6d9cbe 100644 (file)
@@ -1,5 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<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="startup" xml:lang="ja">
+<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="startup" xml:lang="ja">
     <refnamediv>
         <refname>startup</refname>
         <refpurpose>スタートアップファイル</refpurpose>
@@ -36,18 +39,12 @@ end
             <member>
                 <link linkend="scilab">scilab</link>
             </member>
-        </simplelist>
-        <simplelist type="inline">
             <member>
                 <link linkend="SCIHOME">SCIHOME</link>
             </member>
-        </simplelist>
-        <simplelist type="inline">
             <member>
                 <link linkend="SCI">SCI</link>
             </member>
-        </simplelist>
-        <simplelist type="inline">
             <member>
                 <link linkend="TMPDIR">TMPDIR</link>
             </member>
index ac4760b..a676f54 100644 (file)
             <member>
                 <link linkend="SCI">SCI</link>
             </member>
-        </simplelist>
-        <simplelist type="inline">
             <member>
                 <link linkend="TMPDIR">TMPDIR</link>
             </member>
-        </simplelist>
-        <simplelist type="inline">
             <member>
                 <link linkend="scilab">Scilab startup</link>
             </member>
index 78c6f90..160cd51 100644 (file)
@@ -1,5 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="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="backslash" xml:lang="pt">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="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="backslash" xml:lang="pt">
     <refnamediv>
         <refname>backslash</refname>
         <refpurpose>(\) divisão matricial direita-esquerda</refpurpose>
@@ -99,7 +102,7 @@ mprintf('\ntime needed to solve the system with the backslash operator: %.3f\n',
         <title>Histórico</title>
         <revhistory>
             <revision>
-                <revnumber>5.4.1</revnumber>
+                <revnumber>5.5.0</revnumber>
                 <revremark>
                   The threshold level which switches between Gaussian Elimination with row pivoting
                   and linear least squares when computing A\B is decreased from sqrt(eps) to eps.
index 685a7b4..b63e4e8 100644 (file)
@@ -1,5 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<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="startup" xml:lang="pt">
+<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="startup" xml:lang="pt">
     <refnamediv>
         <refname>startup</refname>
         <refpurpose>arquivo de inicialização</refpurpose>
             uma nova linha a ser levada em conta.
         </para>
         <para>Definição de SCIHOME : no Windows : C:/Documents e
-            Settings/&lt;User&gt;/Scilab/&lt;Scilab-Version&gt;
+            Settings/&lt;User>/Scilab/&lt;Scilab-Version>
         </para>
         <para>ou no Vista :
-            C:/&lt;User&gt;/AppData/Roaming/Scilab/&lt;Scilab-Version&gt;
+            C:/&lt;User>/AppData/Roaming/Scilab/&lt;Scilab-Version>
         </para>
         <para>No Linux/Unix :
-            /home/&lt;User&gt;/.Scilab/&lt;Scilab-Version&gt;
+            /home/&lt;User>/.Scilab/&lt;Scilab-Version>
         </para>
     </refsection>
     <refsection>
             <member>
                 <link linkend="scilab">scilab</link>
             </member>
+            <member>
+                <link linkend="SCIHOME">SCIHOME</link>
+            </member>
+            <member>
+                <link linkend="SCI">SCI</link>
+            </member>
+            <member>
+                <link linkend="TMPDIR">TMPDIR</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
index 496eeaf..294f84b 100644 (file)
@@ -73,7 +73,7 @@ b=[
    30.
 ];
 x=A\b
-A*x-b // close to zero
+A*x-b // близко к нулю
 
 A=rand(3,2);
 b=[1;1;1];
@@ -143,12 +143,13 @@ mprintf('\nвремя, необходимое для решения систем
         </simplelist>
     </refsection>
     <refsection>
-        <title>History</title>
+        <title>История</title>
         <revhistory>
             <revision>
-                <revnumber>5.4.1</revnumber>
+                <revnumber>5.5.0</revnumber>
                 <revremark>
-                    Пороговый уровень для обусловливания в обратном слэше увеличен.
+                  Пороговый уровень, который переключает при вычислении A\B между исключением по
+                  методу Гаусса и перестановкой строк матрицы, уменьшен от sqrt(eps) до eps.
                 </revremark>
             </revision>
         </revhistory>
index ac0a7f9..7803656 100644 (file)
@@ -533,6 +533,9 @@ echo $? ]]></screen>
                 <link linkend="getversion">getversion</link>
             </member>
             <member>
+                <link linkend="getscilabmode">getscilabmode</link>
+            </member>
+            <member>
                 <link linkend="consolebox">consolebox</link>
             </member>
             <member>
index 6d922be..fe124dd 100644 (file)
@@ -1,5 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<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="startup" xml:lang="ru">
+<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="startup" xml:lang="ru">
     <refnamediv>
         <refname>начальный запуск</refname>
         <refpurpose>файлы начального запуска</refpurpose>
@@ -15,7 +18,8 @@
     <refsection>
         <title>Примечания</title>
         <para>
-            Для того, чтобы последняя строка файла начального запуска была учтена, необходимо, чтобы файл заканчивался новой пустой строкой.
+            Для того, чтобы последняя строка файла начального запуска была учтена, необходимо,
+            чтобы файл заканчивался новой пустой строкой.
         </para>
     </refsection>
     <refsection>
@@ -33,18 +37,12 @@ end
             <member>
                 <link linkend="scilab">scilab</link>
             </member>
-        </simplelist>
-        <simplelist type="inline">
             <member>
                 <link linkend="SCIHOME">SCIHOME</link>
             </member>
-        </simplelist>
-        <simplelist type="inline">
             <member>
                 <link linkend="SCI">SCI</link>
             </member>
-        </simplelist>
-        <simplelist type="inline">
             <member>
                 <link linkend="TMPDIR">TMPDIR</link>
             </member>
index 8724de9..878372e 100644 (file)
             <member>
                 <link linkend="SCI">SCI</link>
             </member>
-        </simplelist>
-        <simplelist type="inline">
             <member>
                 <link linkend="TMPDIR">TMPDIR</link>
             </member>
-        </simplelist>
-        <simplelist type="inline">
             <member>
                 <link linkend="scilab">Scilab startup</link>
             </member>
index d11537e..febcb13 100644 (file)
@@ -9,4 +9,4 @@
 // For more information, see the COPYING file which you should have received
 // along with this program.
 
-add_help_chapter("Qualité",SCI+"/modules/coverage/help/fr_FR",%T);
+add_help_chapter("Performances des programmes",SCI+"/modules/coverage/help/fr_FR",%T);
index 66fc148..bdbb144 100644 (file)
@@ -27,7 +27,7 @@
         <title>Syntax</title>
         <synopsis>
             y = log2(x)
-            [m,e] = log2(u)
+            [m, e] = log2(u)
         </synopsis>
     </refsynopsisdiv>
     <refsection>
             </note>
         </para>
         <para>
-            <literal>[m,e]=log2(u)</literal> computes in an element-wise way the base-2 mantissa
+            <literal>[m, e] = log2(u)</literal> computes in an element-wise way the base-2 mantissa
             <varname>m</varname> and exponent <varname>e</varname> of every elements of
             <varname>u</varname>. Hence, for any index <literal>k</literal> we have
             <literal>u(k) = m(k) .* 2.^e(k)</literal> with <literal>0.5 ≤ |m(k)| &lt; 1</literal>.
             <note>
                 <itemizedlist>
                     <listitem>
-                        <literal>[m,e]=log2([0 %nan -%inf %inf])</literal> returns
+                        <literal>[m, e] = log2([0 %nan -%inf %inf])</literal> returns
                         <literal>m=[0  NaN -Inf Inf]</literal> and <literal>e=[0 0 0 0]</literal>.
                     </listitem>
                     <listitem>
index 4a40173..b21758c 100644 (file)
@@ -225,7 +225,7 @@ d, k
 
  k  =
    6.   1.   10.   9.
- ]]></screen>
+]]></screen>
         <para>
             <emphasis role="bold">Example #2: column-wise processing</emphasis>
         </para>
@@ -254,7 +254,7 @@ d, k
 
  k  =
    6.   1.   7.   5.
- ]]></screen>
+]]></screen>
         <para>
             <emphasis role="bold">Example #3: with some text</emphasis>
         </para>
index b5f40b4..60dce6f 100644 (file)
  * 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: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="atanh" xml:lang="en">
+<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="atanh" xml:lang="en">
     <refnamediv>
         <refname>atanh</refname>
         <refpurpose>hyperbolic tangent inverse</refpurpose>
             evaluate an elementary mathematical function outside its definition domain
             in the real case, then the complex extension is used (with a complex
             result). The most famous example being the <function>sqrt</function> function (try
-            <code>sqrt(-1)</code>!). This approach have some drawbacks when you
-            evaluate the function at a singular point which may led to different
-            results when the point is considered as real or complex. For the
-            <function>atanh</function> this occurs for <literal>-1</literal> and
-            <literal>1</literal> because the at these points the imaginary part do not
+            <code>sqrt(-1)</code>!).
+        </para>
+        <para>
+            This approach has some drawbacks when you
+            evaluate the function at a singular point which may lead to different
+            results when the point is considered as real or complex.
+        </para>
+        <para>
+            For <literal>atanh()</literal>, this occurs for <literal>-1</literal> and
+            <literal>1</literal>, because at these points the imaginary part does not
             converge and so <literal>atanh(1) = +Inf + i NaN</literal> while
-            <literal>atanh(1) = +Inf</literal> for the real case (as lim <literal>x-&gt;1</literal>  of
-            <code>atanh(x)</code>). So when you evaluate this function on the vector <literal>[1 2]</literal>
+            <literal>atanh(1) = +Inf</literal> for the real case (as lim <literal>x-&gt;1</literal>
+            of <code>atanh(x)</code>).
+        </para>
+        <para>
+            So when you evaluate this function on the vector <literal>[1 2]</literal>
             then like <literal>2</literal> is outside the definition
             domain, the complex extension is used for all the vector and you get
-            <literal>atanh(1) = +Inf + i NaN</literal> while you get <literal>atanh(1)
-                = +Inf
-            </literal>
-            with <literal>[1 0.5]</literal> for instance.
+            <literal>atanh(1) = +Inf + i NaN</literal> while you get
+            <literal>atanh(1) = +Inf</literal> with <literal>[1, 0.5]</literal> for instance.
         </para>
     </refsection>
     <refsection>
index c3e6e96..4d2ba30 100644 (file)
@@ -157,8 +157,9 @@ linspace([1:4]', [5:8]', 10)   // avec des colonnes de bornes
 ]]></screen>
     <para/>
     <para>
-        <emphasis role="bold">With encoded integers:</emphasis>
-        The step may vary by one unit along the series:
+        <emphasis role="bold">Avec des entiers encodés :</emphasis>
+        le pas peut varier d'au plus une unité en cours de série, afin d'assurer que la borne
+        supérieure est toujours atteinte :
     </para>
         <programlisting role="example"><![CDATA[
 x = linspace(int8([5;127]), int8([127;5]), 10)
index 2853871..8322e27 100644 (file)
@@ -14,7 +14,8 @@
             <varlistentry>
                 <term>X</term>
                 <listitem>
-                    <para>matrice carrée réelle ou complexe.</para>
+                    <para>scalaire, vecteur, matrice ou hypermatrice de nombres réels ou complexes.
+                    </para>
                 </listitem>
             </varlistentry>
         </variablelist>
index a71735d..eec08b8 100644 (file)
@@ -25,7 +25,7 @@
         <title>Séquence d'appel</title>
         <synopsis>
             y = log2(x)
-            [f, e] = log2(u)
+            [m, e] = log2(u)
         </synopsis>
     </refsynopsisdiv>
     <refsection>
             </note>
         </para>
         <para>
-            <literal>[m,e]=log2(u)</literal> calcule élément par élément la mantisse
+            <literal>[m, e] = log2(u)</literal> calcule élément par élément la mantisse
             <varname>m</varname> et l'exposant <varname>e</varname> de tous les éléments de
             <varname>u</varname>. Ainsi, pour tout indice <literal>k</literal> nous avons
             <literal>u(k) = m(k) .* 2.^e(k)</literal> avec <literal>0.5 ≤ |m(k)| &lt; 1</literal>.
             <note>
                 <itemizedlist>
                     <listitem>
-                        <literal>[m,e]=log2([0 %nan -%inf %inf])</literal> donne
+                        <literal>[m, e] = log2([0 %nan -%inf %inf])</literal> donne
                         <literal>m=[0  NaN -Inf Inf]</literal> et <literal>e=[0 0 0 0]</literal>.
                     </listitem>
                     <listitem>
index c9649ff..6908926 100644 (file)
@@ -2,6 +2,7 @@
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2006-2008 - INRIA
+ * Copyright (C) 2018 - Samuel GOUGEON
  *
  * Copyright (C) 2012 - 2016 - Scilab Enterprises
  *
  * along with this program.
  *
  -->
+<!--  module: polynomials  -->
 <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="lcm">
-    <refnamediv>
-        <refname>lcm</refname>
-        <refpurpose>наименьшее общее кратное (НОК)</refpurpose>
-    </refnamediv>
-    <refsynopsisdiv>
-        <title>Синтаксис</title>
-        <synopsis>
-           pp = lcm(p)
-          [pp, fact] = lcm(p)
-        </synopsis>
-    </refsynopsisdiv>
-    <refsection>
-        <title>Аргументы</title>
-        <variablelist>
-            <varlistentry>
-                <term>p</term>
-                <listitem>
-                    <para>
-                        вектор-строка полиномиальных значений <literal>p = [p1, ..., pn]</literal> либо
-                        вектор-строка целочисленных значений (тип 8).
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>fact</term>
-                <listitem>
-                    <para>
-                        вектор полиномиальных или целочисленных значений (тип 8).
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>pp</term>
-                <listitem>
-                    <para>полином или целое число.</para>
-                </listitem>
-            </varlistentry>
-        </variablelist>
-    </refsection>
-    <refsection>
-        <title>Описание</title>
-        <para>
-            <code>pp=lcm(p)</code> вычисляет наименьшее общее кратное <varname>pp</varname> вектора
-            полиномиальных значений <varname>p</varname>.
-        </para>
-        <para>
-            <code>[pp, fact]=lcm(p)</code> вычисляет дополнительно вектор <varname>fact</varname>
-            такой, что <literal>p .* fact = pp * ones(p)</literal>.
-        </para>
-        <para>
-          If <literal>p</literal> is a set of integers with some negative ones, the returned value
-          <literal>pp</literal> of their LCM is always positive.
-        </para>
-        <para>
-            If <literal>p</literal> is an array of decimal integers, they are priorly converted
-            into <literal>int32</literal> before processing.
-        </para>
-    </refsection>
-    <refsection>
-        <title>Примеры</title>
-        <programlisting role="example"><![CDATA[
-//случай полиномов
-s=poly(0,'s');
-p=[s,s*(s+1)^2,s^2*(s+2)];
-[pp,fact]=lcm(p);
-p.*fact, pp
+         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="lcm">
+   <refnamediv>
+       <refname>lcm</refname>
+       <refpurpose>наименьшее общее кратное (положительное) целых чисел или полиномов</refpurpose>
+   </refnamediv>
+   <refsynopsisdiv>
+       <title>Синтаксис</title>
+       <synopsis>
+          pp = lcm(p)
+         [pp, fact] = lcm(p)
+       </synopsis>
+   </refsynopsisdiv>
+   <refsection>
+       <title>Аргументы</title>
+       <variablelist>
+           <varlistentry>
+               <term>p</term>
+               <listitem>
+                   <para>
+                       матрица полиномов (тип 2), или десятичных чисел или кодированных целых
+                       чисел (тип 1 или 8).
+                   </para>
+               </listitem>
+           </varlistentry>
+           <varlistentry>
+               <term>pp</term>
+               <listitem>
+                   <para>
+                       полином или десятичное целое число: положительное нименьшее общее кратное у
+                       составляющих <varname>p</varname>.
+                   </para>
+               </listitem>
+           </varlistentry>
+           <varlistentry>
+               <term>fact</term>
+               <listitem>
+                   <para>
+                       матрица полиномов или десятичных целых чисел (тип 1) с размером, как у
+                       <varname>p</varname>, такая, что <literal>fact(i)= pp./p(i)</literal>.
+                   </para>
+               </listitem>
+           </varlistentry>
+       </variablelist>
+   </refsection>
+   <refsection>
+       <title>Описание</title>
+       <para>
+           <literal>pp=lcm(p)</literal>  вычисляет НОК <varname>pp</varname> составляющих <varname>p</varname>.
+       </para>
+       <para>
+         Если <literal>p</literal> являются полиномами, то <literal>pp</literal> является полиномом и
+         <varname>fact</varname> также является матрицей полиномов.
+       </para>
+       <para>
+         Если <literal>p</literal> является массивом целых числел, то
+           <itemizedlist>
+               <listitem>
+                   если они являются кодированными целыми числами, то тогда они преобразуются
+                   в десятичные целые числи перед обработкой.
+               </listitem>
+               <listitem>
+                   Любые входные целые числа типа int64 или uint64 по модулю больше 2^53
+                   будут усечены и <literal>lcm()</literal> вернёт неверный результат.
+               </listitem>
+               <listitem>
+                   Если некоторые из них отрицательные, то возвращаемое значение <literal>pp</literal>
+                   (их НОК) будет всегда положительным.
+               </listitem>
+           </itemizedlist>
+       </para>
+       <para>
+           Намиеньшее общее кратное массива <literal>p</literal> вещественных чисел может быть
+           получено конвертированием его в полином перед вызовом <literal>lcm</literal>,
+           через <literal>p = inv_coeff(p, 0)</literal>.
+       </para>
+   </refsection>
+   <refsection>
+       <title>Примеры</title>
+       <para>С полиномами:</para>
+       <programlisting role="example"><![CDATA[
+s = %s;
+p = [s , s*(s+1) , s^2-1]
+[pp, fact] = lcm(p)
+p .* fact == pp
+]]></programlisting>
+   <screen><![CDATA[
+--> p = [s , s*(s+1) , s^2-1]
+ p  =
+           2       2
+   s   s +s   -1 +s
 
-//случай целых чисел
-V=int32([2^2*3^5, 2^3*3^2,2^2*3^4*5]);
-lcm(V)
+--> [pp, fact] = lcm(p)
+ fact  =
+       2
+  -1 +s   -1 +s   s
+
+ pp  =
+       3
+  -s +s
+
+--> p .* fact == pp
+ ans  =
+  T T T
+]]></screen>
+   <para>С кодированными целыми числами:</para>
+   <programlisting role="example"><![CDATA[
+// Простые числа: 2  3  5  7  11  13  17  19  23  29  31  37  41  43  47
+V = int16([2*3 3*7 ; 7*5  3*5])
+[pp, fact] = lcm(V)
+ ]]></programlisting>
+    <screen><![CDATA[
+--> V = int16([2*3 3*7 ; 7*5  3*5])
+ V  =
+   6  21
+  35  15
+
+--> [pp, fact] = lcm(V)
+ pp  =
+   210.
+
+ fact  =
+   35.   10.
+   6.    14.
+]]></screen>
+    <para>С десятичнми целыми числами:</para>
+    <programlisting role="example"><![CDATA[
+V = [2*3 3*7 ; 7*5  3*5]
+[pp, fact] = lcm(V)
+ ]]></programlisting>
+    <para>С большими целыми числами:</para>
+    <programlisting role="example"><![CDATA[
+V = [3*2^51 , 3*5]
+[pp, fact] = lcm(V)    // OK
  ]]></programlisting>
-    </refsection>
-    <refsection role="see also">
-        <title>Смотрите также</title>
-        <simplelist type="inline">
-            <member>
-                <link linkend="gcd">gcd</link>
-            </member>
-            <member>
-                <link linkend="bezout">bezout</link>
-            </member>
-        </simplelist>
-    </refsection>
-    <refsection role="history">
-        <title>История</title>
-        <revhistory>
-            <revision>
-                <revnumber>6.0.1</revnumber>
-                <revdescription>
-                   For input integers possibly negative, the returned LCM is now always positive.
-                </revdescription>
-            </revision>
-        </revhistory>
-    </refsection>
+    <screen><![CDATA[
+--> V = [3*2^51 , 3*5]
+ V  =
+   6.755D+15   15.
+
+--> [pp, fact] = lcm(V)
+ fact  =
+   5.   2.252D+15
+
+ pp  =
+   3.378D+16
+]]></screen>
+    <para>
+        Когда числовое кодирование переполняет разрядную сетку, происходит усечение
+        и результаты возвращаются ошибочные:
+    </para>
+    <programlisting role="example"><![CDATA[
+V = [3*2^52 , 3*5]
+[pp, fact] = lcm(V)
+ ]]></programlisting>
+    <screen><![CDATA[
+--> V = [3*2^52 , 3*5]
+ V  =
+   1.351D+16   15.
+
+--> [pp, fact] = lcm(V)
+ fact  =
+   15.   1.351D+16
+
+ pp  =
+   2.027D+17
+]]></screen>
+   </refsection>
+   <refsection role="see also">
+       <title>Смотрите также</title>
+       <simplelist type="inline">
+           <member>
+               <link linkend="gcd">gcd</link>
+           </member>
+           <member>
+               <link linkend="bezout">bezout</link>
+           </member>
+           <member>
+               <link linkend="factor">factor</link>
+           </member>
+       </simplelist>
+   </refsection>
+   <refsection role="history">
+       <title>История</title>
+       <revhistory>
+           <revision>
+               <revnumber>6.0.1</revnumber>
+               <revdescription>
+                  Для входных целых чисел, возможно отрицательных, возвращаемое МОК теперь
+                  всегда положительно.
+               </revdescription>
+           </revision>
+           <revision>
+               <revnumber>6.0.2</revnumber>
+               <revdescription>
+                   <itemizedlist>
+                       <listitem>
+                           Теперь поддерживаются входные кодированные целые числа типа int64 и uint64.
+                       </listitem>
+                       <listitem>
+                           Теперь <varname>p</varname> может быть матрицей любой формы, необязательно строка.
+                       </listitem>
+                       <listitem>
+                           Когда <varname>p</varname> является матрицей кодированных или десятичных целых
+                           чисел, то вычисления теперь выполняются в числах с плавающей запятой вместо
+                           формата int32.
+                           <varname>pp</varname> и <varname>fact</varname> теперь десятичные целые числа
+                           (вместо целых чисел типа int32).
+                       </listitem>
+                   </itemizedlist>
+               </revdescription>
+           </revision>
+       </revhistory>
+   </refsection>
 </refentry>
index a882765..3633767 100644 (file)
@@ -25,7 +25,7 @@
         <title>Синтаксис</title>
         <synopsis>
             y = log2(x)
-            [f, e] = log2(u)
+            [m, e] = log2(u)
         </synopsis>
     </refsynopsisdiv>
     <refsection>
             </note>
         </para>
         <para>
-            <literal>[m,e]=log2(u)</literal> вычисляет поэлементно мантиссу по основанию 2
+            <literal>[m, e] = log2(u)</literal> вычисляет поэлементно мантиссу по основанию 2
             <varname>m</varname> и экспоненту <varname>e</varname> каждого элемента
             <varname>u</varname>. Следовательно, для любого индекса <literal>k</literal> имеем
             <literal>u(k) = m(k) .* 2.^e(k)</literal> при <literal>0.5 ≤ |m(k)| &lt; 1</literal>.
             <note>
                 <itemizedlist>
                     <listitem>
-                        <literal>[m,e]=log2([0 %nan -%inf %inf])</literal> возвращает
+                        <literal>[m, e] = log2([0 %nan -%inf %inf])</literal> возвращает
                         <literal>m=[0  NaN -Inf Inf]</literal> и <literal>e=[0 0 0 0]</literal>.
                     </listitem>
                     <listitem>
index d542650..fcdd524 100644 (file)
@@ -222,7 +222,7 @@ d, k
    1.   2.   3.   8.
  k  =
    6.   1.   10.   9.
- ]]></screen>
+]]></screen>
         <para>
             <emphasis role="bold">Пример №2: постолбцовая обработка</emphasis>
         </para>
@@ -248,7 +248,7 @@ d, k
    1.   2.   2.   0.
  k  =
    6.   1.   7.   5.
- ]]></screen>
+]]></screen>
         <para>
             <emphasis role="bold">Пример №3: с текстом</emphasis>
         </para>
index 8b9d64d..bc15212 100644 (file)
@@ -5,18 +5,21 @@
 * Copyright (C) 2013 - S/E - Sylvestre Ledru
 * Copyright (C) 2012 - CNES - Simon Billemont
 *
- * 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.
+* 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" version="5.0-subset Scilab" xml:lang="en" xml:id="jims-getting-started">
+<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" version="5.0-subset Scilab" xml:lang="en"
+          xml:id="jims-getting-started">
     <refnamediv>
         <refname>Getting started - Beginning</refname>
         <refpurpose>How to use the Java Scilab binding?</refpurpose>
@@ -28,7 +31,9 @@
     </refsection>
     <refsection>
         <title>Basic</title>
-        <para>Before starting, it is convenient to know the most important functions and what they do. These frequently used functions are the following Scilab functions:
+        <para>
+            Before starting, it is convenient to know the most important functions and what they do.
+            These frequently used functions are the following Scilab functions:
             <itemizedlist>
                 <listitem>
                     <link linkend="jimport">jimport</link>: Import a Java class
             </itemizedlist>
         </para>
         <para>
-            jimport is the function that mirrors the functionality of the java statement 'import', and loads the specified class definition/template of a given class in memory. When loaded, this definition is used to accesses static methods/members, and create new objects.
+            jimport is the function that mirrors the functionality of the java statement 'import',
+            and loads the specified class definition/template of a given class in memory.
+            When loaded, this definition is used to accesses static methods/members,
+            and create new objects.
         </para>
         <para>
-            jinvoke is a function that calls (invokes) a specified method on a java class or object. This invoke has an optional set of parameters that must coincide with the actual member signature. This means you must pass the same number of arguments, and these arguments must have the correct type.
+            jinvoke is a function that calls (invokes) a specified method on a java class or object.
+            This invoke has an optional set of parameters that must coincide with the actual member
+            signature. This means you must pass the same number of arguments, and these arguments
+            must have the correct type.
         </para>
     </refsection>
     <refsection>
         <title>Example 1: Creating a basic class and calling a simple method</title>
-        <para>In this first example, the three basic pillars of working with Java are treated. The first is to load a class, then an instance is constructed and finally the invocation or calling of one of this methods or members.</para>
         <para>
-            Consider a basic class as presented in the example <literal>HelloWorld</literal>. It has a default constructor generating a message upon construction and one public method which also shows a message when it has been called. This class should now be compiled into java byte-code. When developing your own code, then this section is usually handled by your IDE (integrated development environment). If you plan to use external libraries, these will available in precompiled form (packed in a JAR).
+            In this first example, the three basic pillars of working with Java are treated.
+            The first is to load a class, then an instance is constructed and finally the invocation
+            or calling of one of this methods or members.
+        </para>
+        <para>
+            Consider a basic class as presented in the example <literal>HelloWorld</literal>.
+            It has a default constructor generating a message upon construction and one
+            public method which also shows a message when it has been called.
+            This class should now be compiled into java byte-code. When developing your own code,
+            then this section is usually handled by your IDE (integrated development environment).
+            If you plan to use external libraries, these will available in precompiled form
+            (packed in a JAR).
         </para>
         <programlisting role="java"><![CDATA[
 // Save under the name HelloWorld.java
@@ -69,86 +90,105 @@ public class HelloWorld {
 javacode=mgetl(fullfile(TMPDIR, 'HelloWorld.java'));
 jcompile("com.foo.HelloWorld",javacode);
       ]]></programlisting>
-        <para>Once the compiled version of this Java class exists, we can start Scilab and try to get Scilab to show us the various messages.
-            Now the HelloWorld class can be imported into our workspace. This is done using the already mentioned jimport:
+        <para>Once the compiled version of this Java class exists, we can start Scilab and try
+            to get Scilab to show us the various messages.
+            Now the HelloWorld class can be imported into our workspace. This is done using the
+            already mentioned jimport:
             <screen>
-                -->jimport com.foo.HelloWorld
+--> jimport com.foo.HelloWorld
 
-                -->HelloWorld
-                HelloWorld  =
+--> HelloWorld
+HelloWorld  =
+class com.foo.HelloWorld
 
-                class com.foo.HelloWorld
-
-                -->whos -name HelloWorld
-                Name                     Type           Size           Bytes
-
-                HelloWorld               _EClass        ?              168
-            </screen>
+--> whos -name HelloWorld
+Name                     Type           Size           Bytes
+HelloWorld               _EClass        ?              168
+</screen>
             <para>
-                Upon competition, an additional variable named HelloWorld has been created. This is equivalent to a Class object in java. From this class object, new objects of the HelloWorld type can be created.
+                Upon competition, an additional variable named HelloWorld has been created.
+                This is equivalent to a Class object in java. From this class object,
+                new objects of the HelloWorld type can be created.
             </para>
             <para>
-                Creating such an object instance can be done by invoking <link linkend="new">new</link> on the class definition. The arguments to this function are the parameters that are delegated to the Java constructor. The result of this operation is a new Java object reference which can be stored in a variable for later use.
+                Creating such an object instance can be done by invoking <link linkend="new">new</link>
+                on the class definition. The arguments to this function are the parameters that are
+                delegated to the Java constructor.
+                The result of this operation is a new Java object reference which can be stored
+                in a variable for later use.
             </para>
             <screen>
-                -->object = HelloWorld.new();
-                HelloWorld constructed!
-
-                -->object
-                object  =
-
-                com.foo.HelloWorld@49aacd5f
+--> object = HelloWorld.new();
+HelloWorld constructed!
 
-                -->whos -name object
-                Name                     Type           Size           Bytes
+--> object
+object  =
+com.foo.HelloWorld@49aacd5f
 
-                object                   _EObj          ?              160
-            </screen>
+--> whos -name object
+Name                     Type           Size           Bytes
+object                   _EObj          ?              160
+</screen>
             <para>
-                What one sees when the <link linkend="new">new</link> operator is called on the JClass, it transparently invokes the Java constructor, and our "HelloWorld constructed!" message appears. The resulting HelloWorld object is stored in the "object" variable. When the variable name is reentered in the command line, the details of its reference are shown. This message can be customized by overriding the toString method in the HelloWorld class.
+                What one sees when the <link linkend="new">new</link> operator is called on the
+                JClass, it transparently invokes the Java constructor, and our
+                "HelloWorld constructed!" message appears. The resulting HelloWorld object is
+                stored in the "object" variable. When the variable name is reentered in the
+                command line, the details of its reference are shown. This message can be
+                customized by overriding the toString method in the HelloWorld class.
             </para>
             <para>
-                Now that a specific HelloWorld object has been created, one can try to call the public method that has been declared; <literal>HelloWorld\#message()</literal>. The same natural technique as with <link linkend="new">new</link> can then be applied to invoke the method:
+                Now that a specific HelloWorld object has been created, one can try to call
+                the public method that has been declared; <literal>HelloWorld\#message()</literal>.
+                The same natural technique as with <link linkend="new">new</link> can then be
+                applied to invoke the method:
             </para>
             <screen>
-                -->object.message();
-                Hello world!
-            </screen>
+--> object.message();
+Hello world!
+</screen>
             <para>
-                The dot operator (dot between object and message) is actually a handy shortcut and expands the following snippet of Scilab code. The use of this shortcut makes it simpler and cleaner to invoke methods/get member variables.
+                The dot operator (dot between object and message) is actually a handy shortcut
+                and expands the following snippet of Scilab code. The use of this shortcut
+                makes it simpler and cleaner to invoke methods/get member variables.
             </para>
             <screen>
-                -->jinvoke(object, 'message');
-                Hello world!
-            </screen>
+--> jinvoke(object, 'message');
+Hello world!
+</screen>
         </para>
     </refsection>
     <refsection>
         <title>Example 2: Exchanging Scilab and Java primitives</title>
         <para>
-            This example treats the way you can exchange primitive data types and strings between Scilab and Java. We will be passing various types of objects between these two languages.
+            This example treats the way you can exchange primitive data types and strings between
+            Scilab and Java. We will be passing various types of objects between these two languages.
         </para>
         <para>
-            For this an example class (see Class Inspector) has been defined that takes and returns objects.
-            There are two methods defined. The first takes a double does some arithmetic and returns a result: Inspector#eval(double). The other methods takes any object, shows some basic information and returns it: Inspector#inspect(Object).
+            For this an example class (see Class Inspector) has been defined that takes and
+            returns objects.
+            There are two methods defined. The first takes a double does some arithmetic and
+            returns a result: Inspector#eval(double). The other methods takes any object,
+            shows some basic information and returns it: Inspector#inspect(Object).
         </para>
         <programlisting role="java"><![CDATA[
 // Save under the name Inspector.java
 package com.foo;
 public class Inspector {
-       public double eval(double x) {
-               return x / 2.;
-       }
-
-       public Object inspect(Object prototype) {
-               System.err.println("Inspecting: '" + prototype + "'");
-               System.err.println("Class: " + prototype.getClass().getSimpleName());
-               return prototype;
-       }
+    public double eval(double x) {
+        return x / 2.;
+    }
+
+    public Object inspect(Object prototype) {
+        System.err.println("Inspecting: '" + prototype + "'");
+        System.err.println("Class: " + prototype.getClass().getSimpleName());
+        return prototype;
+    }
 }
       ]]></programlisting>
         <para>
-            As in the previous example, this code must be compiled to Java byte-code before it can be used directly.
+            As in the previous example, this code must be compiled to Java byte-code before
+            it can be used directly.
         </para>
         <programlisting role="example"><![CDATA[
 // How to compile the Java code from Scilab
@@ -157,153 +197,155 @@ jcompile("com.foo.Inspector",javacode);
       ]]></programlisting>
         To start, import the Inspector class and create an Inspector object:
         <screen>
-            -->jimport('com.foo.Inspector');
-
-            -->myInspector = Inspector.new()
-            myInspector  =
-
-            com.foo.Inspector@2a788315
-        </screen>
-
-        Now information between the two systems can be passing along. When passing along any of the Scilab data types into Java, it is automatically wrapped (see <link linkend="jwrap">jwrap</link>) to its Java equivalent. First, an example using the most used data type in Scilab; reals (constant) is given. When passing along a real, this type gets automatically mapped to the Scilab type double. Let's try;
+--> jimport('com.foo.Inspector');
+
+--> myInspector = Inspector.new()
+myInspector  =
+com.foo.Inspector@2a788315
+</screen>
+        Now information between the two systems can be passing along.
+        When passing along any of the Scilab data types into Java, it is automatically wrapped
+        (see <link linkend="jwrap">jwrap</link>) to its Java equivalent.
+        First, an example using the most used data type in Scilab; reals (constant) is given.
+        When passing along a real, this type gets automatically mapped to the Scilab type double.
+        Let's try;
         <screen>
-            -->result = myInspector.eval(12.5)
-            result  =
-
-            6.25
-
-            -->result * 2
-            ans  =
-
-            12.5
-
-            -->whos -name result
-            Name                     Type           Size           Bytes
-
-            result                   constant       1 by 1         24
-        </screen>
-        The automatic convert is controlled by the jautoUnwrap function. Without this function, all the conversions have to be done explicitly.
+--> result = myInspector.eval(12.5)
+result  =
+6.25
+
+--> result * 2
+ans  =
+12.5
+
+--> whos -name result
+Name                     Type           Size           Bytes
+result                   constant       1 by 1         24
+</screen>
+        <para/>
+        The automatic convert is controlled by the jautoUnwrap function.
+        Without this function, all the conversions have to be done explicitly.
         <screen>
-            -->result = myInspector.eval(12.5)
-            result  =
-
-            6.25
-
-            -->result * 2
-            ans  =
-
-            null
+--> result = myInspector.eval(12.5)
+result  =
+6.25
 
-            -->whos -name result
-            Name                     Type           Size           Bytes
+--> result * 2
+ans  =
+null
 
-            result                   _EObj          ?              160
+--> whos -name result
+Name                     Type           Size           Bytes
+result                   _EObj          ?              160
         </screen>
-        The result that is returned seems to be correct at first glance ($12.5/2=6.25$). However upon closer inspection, notice that what is returned from our function call is not a number. What we received is another Java object (Double in this case). To be able to use the given data in again in Scilab, the already mentioned <link linkend="junwrap">junwrap</link> functionality can be used if the jautoUnwrap is not set to true.
-        This transforms Java types back to there equivalent Scilab form. From then onward we have a normal number again:
+        <para/>
+        The result that is returned seems to be correct at first glance ($12.5/2=6.25$).
+        However upon closer inspection, notice that what is returned from our function call
+        is not a number. What we received is another Java object (Double in this case).
+        To be able to use the given data in again in Scilab, the already mentioned
+        <link linkend="junwrap">junwrap</link> functionality can be used if the jautoUnwrap
+        is not set to true.
+        This transforms Java types back to there equivalent Scilab form. From then onward we
+        have a normal number again:
         <screen>
-            -->result = junwrap(result)
-            result  =
-
-            6.25
-
-            -->whos -name result
-            Name                     Type           Size           Bytes
-
-            result                   constant       1 by 1         24
-
-            -->result * 2
-            ans  =
-
-            12.5
-        </screen>
-
-        From this example is clear how doubles get automatically transformed into a Double, which is used by the Java VM and returned back. When calling <link linkend="junwrap">junwrap</link> on the returned variable, it is transformed back into a native Scilab type. But how do other types work? Let's inspect several of the other primitive types;
+--> result = junwrap(result)
+result  =
+6.25
+
+--> whos -name result
+Name                     Type           Size           Bytes
+result                   constant       1 by 1         24
+
+--> result * 2
+ans  =
+12.5
+</screen>
+        <para/>
+        From this example is clear how doubles get automatically transformed into a Double,
+        which is used by the Java VM and returned back.
+        When calling <link linkend="junwrap">junwrap</link> on the returned variable, it is
+        transformed back into a native Scilab type. But how do other types work? Let's inspect
+        several of the other primitive types;
         <screen>
-            -->jautoUnwrap(%f) // Make sure we disable the auto Unwrap
-
-            -->result = myInspector.inspect("Hello world!");
-            Inspecting: 'Hello world!'
-            Class: String
-
-            -->whos -name result
-            Name                     Type           Size           Bytes
-
-            result                   _EObj          ?              160
-
-            -->result = junwrap(result)
-            result  =
-
-            Hello world!
-
-            -->whos -name result
-            Name                     Type           Size           Bytes
-
-            result                   string         1 by 1         72
-
-            // An Integer
-            -->result = myInspector.inspect(int32(150));
-            Inspecting: '150'
-            Class: Integer
-
-            -->result = junwrap(result)
-            result  =
-
-            150
-
-            -->whos -name result
-            Name                     Type           Size           Bytes
-
-            result                   int32          1 by 1         40
-
-            // A boolean
-            -->result = myInspector.inspect(%t);
-            Inspecting: 'true'
-            Class: Boolean
-
-            -->result = junwrap(result)
-            result  =
-
-            T
-
-            -->whos -name result
-            Name                     Type           Size           Bytes
-
-            result                   boolean        1 by 1         16
-
-        </screen>
-
-        As can be seen, all relevant data types are can be transformed transparently between Scilab and Java type. However this also extends without any additional effort to matrices;
+--> jautoUnwrap(%f) // Make sure we disable the auto Unwrap
+
+--> result = myInspector.inspect("Hello world!");
+Inspecting: 'Hello world!'
+Class: String
+
+--> whos -name result
+Name                     Type           Size           Bytes
+result                   _EObj          ?              160
+
+--> result = junwrap(result)
+result  =
+Hello world!
+
+--> whos -name result
+Name                     Type           Size           Bytes
+result                   string         1 by 1         72
+
+// An Integer
+--> result = myInspector.inspect(int32(150));
+Inspecting: '150'
+Class: Integer
+
+--> result = junwrap(result)
+result  =
+150
+
+--> whos -name result
+Name                     Type           Size           Bytes
+result                   int32          1 by 1         40
+
+// A boolean
+--> result = myInspector.inspect(%t);
+Inspecting: 'true'
+Class: Boolean
+
+--> result = junwrap(result)
+result  =
+T
+
+--> whos -name result
+Name                     Type           Size           Bytes
+result                   boolean        1 by 1         16
+</screen>
+        <para/>
+        As can be seen, all relevant data types are can be transformed transparently between
+        Scilab and Java type. However this also extends without any additional effort to matrices;
         <screen>
-            --> jautoUnwrap(%t) // Make sure we come back in the default mode where Scilab auto unwrap all calls
-
-            -->result = myInspector.inspect(1:5)
-            Inspecting: '[D@b05236'
-            Class: double[]
-            result  =
-
-            1.    2.    3.    4.    5.
-
-            -->whos -name result
-            Name                     Type           Size           Bytes
-
-            result                   constant       1 by 5         56
-
-            -->result = myInspector.inspect(testmatrix('magi',3))
-            Inspecting: '[[D@11d13272'
-            Class: double[][]
-            result  =
-
-            8.    1.    6.
-            3.    5.    7.
-            4.    9.    2.
-
-            -->whos -name result
-            Name                     Type           Size           Bytes
-
-            result                   constant       3 by 3         88
-        </screen>
-        When looking at the class of these wrapped matrices, it is clear that Java stores them as arrays of the appropriate size. When working with 2D matrices, the data in these equivalent Java arrays can be stored in are column-major (default) or row-major mode. In column-major mode, the first array contains a pointer to each of the columns. Whereas in row-major mode, the first array contains the pointers to each row of data. For more information see <link linkend="jautoTranspose">jautoTranspose</link>.
+--> jautoUnwrap(%t) // Make sure we come back in the default mode where Scilab auto unwrap all calls
+
+--> result = myInspector.inspect(1:5)
+Inspecting: '[D@b05236'
+Class: double[]
+result  =
+1.    2.    3.    4.    5.
+
+--> whos -name result
+Name                     Type           Size           Bytes
+result                   constant       1 by 5         56
+
+--> result = myInspector.inspect(testmatrix('magi',3))
+Inspecting: '[[D@11d13272'
+Class: double[][]
+result  =
+8.    1.    6.
+3.    5.    7.
+4.    9.    2.
+
+--> whos -name result
+Name                     Type           Size           Bytes
+result                   constant       3 by 3         88
+</screen>
+        <para/>
+        When looking at the class of these wrapped matrices, it is clear that Java stores them
+        as arrays of the appropriate size. When working with 2D matrices, the data in these
+        equivalent Java arrays can be stored in are column-major (default) or row-major mode.
+        In column-major mode, the first array contains a pointer to each of the columns.
+        Whereas in row-major mode, the first array contains the pointers to each row of data.
+        For more information see <link linkend="jautoTranspose">jautoTranspose</link>.
     </refsection>
     <refsection>
         <title>History</title>
@@ -311,7 +353,9 @@ jcompile("com.foo.Inspector",javacode);
             <revision>
                 <revnumber>5.5.0</revnumber>
                 <revremark>
-                    Function introduced. Based on the 'JIMS' module. The main difference in the behavior compared to the JIMS module is that <link linkend="jautoUnwrap">jautoUnwrap</link> is enabled by default.
+                    Function introduced. Based on the 'JIMS' module. The main difference in the
+                    behavior compared to the JIMS module is that
+                    <link linkend="jautoUnwrap">jautoUnwrap</link> is enabled by default.
                 </revremark>
             </revision>
         </revhistory>
index 8d234b3..f32b8d6 100644 (file)
@@ -5,18 +5,20 @@
 * Copyright (C) 2013 - S/E - Sylvestre Ledru
 * Copyright (C) 2012 - CNES - Simon Billemont
 *
- * 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.
+* 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" version="5.0-subset Scilab" xml:lang="en" xml:id="jims-getting-started-2">
+<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" version="5.0-subset Scilab" xml:lang="en"
+          xml:id="jims-getting-started-2">
     <refnamediv>
         <refname>Getting started - Second step</refname>
         <refpurpose>How to use the Java Scilab binding?</refpurpose>
     </refsection>
     <refsection>
         <title>Example 3: Working with Java objects in Scilab</title>
-        <para>For this example, we define a set of higher abstraction Java objects. Then we will use Scilab as a sort of Java scripting language apply various operations on these objects. A wide variation of Java functionality will be showcased such as; static methods (Factory construct), Enums, simple polymorphism, and scope of members/methods.</para>
         <para>
-            This wide variety of functionality will be demonstrated using a set of 7 simple classes that describe a simple house;
+            For this example, we define a set of higher abstraction Java objects.
+            Then we will use Scilab as a sort of Java scripting language apply various operations on
+            these objects. A wide variation of Java functionality will be showcased such as; static
+            methods (Factory construct), Enums, simple polymorphism, and scope of members/methods.
+        </para>
+        <para>
+            This wide variety of functionality will be demonstrated using a set of
+            7 simple classes that describe a simple house;
         </para>
         <programlisting role="java"><![CDATA[
 // Save under the name House.java
@@ -43,151 +51,156 @@ import java.util.List;
 
 public class House {
 
-       private Color                   color;
-       private Door                    door;
-       private List<IWindow>   windows = new LinkendList<IWindow>();
-
-       public House(Color color, Door door, IWindow... windows) {
-               this.color = color;
-               this.door = door;
-               this.windows.addAll(Arrays.asList(windows));
-       }
-
-       public void repaint() {
-               swapDoorHouseColor();
-       }
-
-       private void swapDoorHouseColor() {
-               Color doorColor = door.getColor();
-               door.repaint(color);
-               color = doorColor;
-       }
-
-       public void addWindow(IWindow window) {
-               windows.add(window);
-       }
-
-       public void replaceDoor(Door newDoor) {
-               this.door = newDoor;
-       }
-
-       @Override
-       public String toString() {
-               return String.format(
-                               "This is a house painted in %s, has a %s door, and %d windows",
-                               color.getDescr(), door.getColor().getDescr(), windows.size());
-       }
+    private Color           color;
+    private Door            door;
+    private List<IWindow>   windows = new LinkendList<IWindow>();
+
+    public House(Color color, Door door, IWindow... windows) {
+        this.color = color;
+        this.door = door;
+        this.windows.addAll(Arrays.asList(windows));
+    }
+
+    public void repaint() {
+        swapDoorHouseColor();
+    }
+
+    private void swapDoorHouseColor() {
+        Color doorColor = door.getColor();
+        door.repaint(color);
+        color = doorColor;
+    }
+
+    public void addWindow(IWindow window) {
+        windows.add(window);
+    }
+
+    public void replaceDoor(Door newDoor) {
+        this.door = newDoor;
+    }
+
+    @Override
+    public String toString() {
+        return String.format(
+                "This is a house painted in %s, has a %s door, and %d windows",
+                color.getDescr(), door.getColor().getDescr(), windows.size());
+    }
 }
       ]]></programlisting>
+        <para/>
         <programlisting role="java"><![CDATA[
 package com.foo;
 
 public class HouseFactory {
 
-       public static House basicHouse() {
-               Door door = new Door(Color.WHITE);
-               IWindow window = new RectangularWindow(2, 0.8);
-               return new House(Color.WHITE, door, window);
-       }
-
-       public static House flashyHouse() {
-               Door door = new Door(Color.random());
-               IWindow window = new CircularWindow(1.2);
-               return new House(Color.random(), door, window);
-       }
+    public static House basicHouse() {
+        Door door = new Door(Color.WHITE);
+        IWindow window = new RectangularWindow(2, 0.8);
+        return new House(Color.WHITE, door, window);
+    }
+
+    public static House flashyHouse() {
+        Door door = new Door(Color.random());
+        IWindow window = new CircularWindow(1.2);
+        return new House(Color.random(), door, window);
+    }
 }
       ]]></programlisting>
+        <para/>
         <programlisting role="java"><![CDATA[
-
 package com.foo;
 
 import java.util.Random;
 
 public enum Color {
 
-       BLACK("black"), BLUE("blue"), BROWN("brown"), GREEN("green"),
-       ORANGE("orange"), RED("red"), WHITE("white"), YELLOW("yellow");
+    BLACK("black"), BLUE("blue"), BROWN("brown"), GREEN("green"),
+    ORANGE("orange"), RED("red"), WHITE("white"), YELLOW("yellow");
 
-       public String   descr;
+    public String   descr;
 
-       private Color(String s) {
-               descr = s;
-       }
+    private Color(String s) {
+        descr = s;
+    }
 
-       public String getDescr() {
-               return descr;
-       }
+    public String getDescr() {
+        return descr;
+    }
 
-       public static Color random() {
-               Color[] allColors = values();
-               return allColors[new Random().nextInt(values().length)];
-       }
+    public static Color random() {
+        Color[] allColors = values();
+        return allColors[new Random().nextInt(values().length)];
+    }
 }      ]]></programlisting>
+        <para/>
         <programlisting role="java"><![CDATA[
 
 package com.foo;
 
 public class Door {
 
-       private Color   color;
+    private Color   color;
 
-       public Door(Color color) {
-               this.color = color;
-       }
+    public Door(Color color) {
+        this.color = color;
+    }
 
-       public Color getColor() {
-               return color;
-       }
+    public Color getColor() {
+        return color;
+    }
 
-       public void repaint(Color newColor) {
-               color = newColor;
-       }
+    public void repaint(Color newColor) {
+        color = newColor;
+    }
 }
       ]]></programlisting>
+        <para/>
         <programlisting role="java"><![CDATA[
 package com.foo;
 
 public interface IWindow {
 
-       double getWindowArea();
+    double getWindowArea();
 
 }
       ]]></programlisting>
+        <para/>
         <programlisting role="java"><![CDATA[
 package com.foo;
 
 public class RectangularWindow implements IWindow {
 
-       double  length;
-       double  width;
+    double  length;
+    double  width;
 
-       public RectangularWindow(double length, double width) {
-               this.length = length;
-               this.width = width;
-       }
+    public RectangularWindow(double length, double width) {
+        this.length = length;
+        this.width = width;
+    }
 
-       public double getWindowArea() {
-               return length * width;
-       }
+    public double getWindowArea() {
+        return length * width;
+    }
 }
       ]]></programlisting>
+        <para/>
         <programlisting role="java"><![CDATA[
 package com.foo;
 
 public class CircularWindow implements IWindow {
 
-       double  radius;
+    double  radius;
 
-       public CircularWindow(double radius) {
-               this.radius = radius;
-       }
+    public CircularWindow(double radius) {
+        this.radius = radius;
+    }
 
-       public double getWindowArea() {
-               return Math.PI * radius * radius;
-       }
+    public double getWindowArea() {
+        return Math.PI * radius * radius;
+    }
 }
       ]]></programlisting>
-
+        <para/>
         <programlisting role="example"><![CDATA[
 // The examples are shipped in the Scilab distribution.
 directory=SCI+"/modules/external_objects_java/examples/com/foo/"
@@ -195,138 +208,151 @@ directory=SCI+"/modules/external_objects_java/examples/com/foo/"
 jcompile(ls(directory + "/*.java"))
       ]]></programlisting>
         <para>
-            First, let's construct a basic factory house. For this, the HouseFactory should be imported and the static method basicHouse() should be invoked.
+            First, let's construct a basic factory house. For this, the HouseFactory should be
+            imported and the static method basicHouse() should be invoked.
         </para>
         <screen>
-            -->jimport("com.foo.HouseFactory")
-
-            -->house = HouseFactory.basicHouse()
-            house  =
+--> jimport("com.foo.HouseFactory")
 
-            This is a house painted in white, has a white door, and 1 windows
-
-        </screen>
+--> house = HouseFactory.basicHouse()
+house  =
+This is a house painted in white, has a white door, and 1 windows
+</screen>
         <para>
-            This shows that static methods can be called as one would in Java. Also keep in mind that this is equivalent to "jinvoke(HouseFactory, 'basicHouse')"
+            This shows that static methods can be called as one would in Java.
+            Also keep in mind that this is equivalent to "jinvoke(HouseFactory, 'basicHouse')"
 
             Also the message of the object has changed from something like:
             <screen>
-                com.foo.House@ae8022
-                To
-                This is a house painted in white, has a white door, and 1 windows
-            </screen>
-            This is due to the fact that the House class has a non-default \cmd[toString] method. This <literal>toString</literal> is used to generate this representation. We can still get the actual type (class) of our House object by invoking <link linkend="jgetclassname">jgetclassname</link>
+com.foo.House@ae8022
+To
+This is a house painted in white, has a white door, and 1 windows
+</screen>
+            This is due to the fact that the House class has a non-default \cmd[toString] method.
+            This <literal>toString</literal> is used to generate this representation.
+            We can still get the actual type (class) of our House object by invoking
+            <link linkend="jgetclassname">jgetclassname</link>
             <screen>
-                -->jgetclassname(house)
-                ans  =
-
-                com.foo.House
-            </screen>
-
-            What is also interesting to know is that we now have a description of a house, without having to import House into Scilab directly!
-            Now that a house has been constructed, it is time to add another window to that house. For this purpose we need to create a new window and add it to the house using the function <literal>addWindow(IWindow)</literal>. <literal>IWindow</literal> is an abstract description of what a window should be and cannot be instantiated directly. There are however two implementations available that we can construct; <literal>RectangularWindow</literal> and <literal>CircularWindow</literal>. Since the house starts with a <literal>RectangularWindow</literal> from the factory, a new <literal>CircularWindow</literal> shall be made.
+--> jgetclassname(house)
+ans  =
+com.foo.House
+</screen>
+            What is also interesting to know is that we now have a description of a house,
+            without having to import House into Scilab directly!
+            Now that a house has been constructed, it is time to add another window to that house.
+            For this purpose we need to create a new window and add it to the house using the
+            function <literal>addWindow(IWindow)</literal>. <literal>IWindow</literal> is an
+            abstract description of what a window should be and cannot be instantiated directly.
+            There are however two implementations available that we can construct;
+            <literal>RectangularWindow</literal> and <literal>CircularWindow</literal>.
+            Since the house starts with a <literal>RectangularWindow</literal> from the factory,
+            a new <literal>CircularWindow</literal> shall be made.
         </para>
         <screen>
-            -->jimport("com.foo.IWindow")
-
-            -->IWindow.new()
-            !--error 999
-            Method invocation: An error occurred: Exception when calling Java method : No such constructor in the class com.foo.IWindow.
-
-            -->jimport("com.foo.CircularWindow")
+--> jimport("com.foo.IWindow")
 
-            --> newWindow = CircularWindow.new(0.5)
-            newWindow  =
+--> IWindow.new()
+!--error 999
+Method invocation: An error occurred: Exception when calling Java method : No such constructor in the class com.foo.IWindow.
 
-            com.foo.CircularWindow@3e389405
+--> jimport("com.foo.CircularWindow")
 
-            -->house.addWindow(newWindow);
+-->  newWindow = CircularWindow.new(0.5)
+newWindow  =
+com.foo.CircularWindow@3e389405
 
-            -->house
-            house  =
+--> house.addWindow(newWindow);
 
-            This is a house painted in white, has a white door, and 2 windows
-
-        </screen>
+--> house
+house  =
+This is a house painted in white, has a white door, and 2 windows
+</screen>
         <para>
-            A new window was made, and it's reference stored in the "newWindow" variable. Next, the window was directly added to the house, without any need to wrap the variable. It basically works as one would expect it to work. Finally, we notice that our house now has 2 windows.
+            A new window was made, and it's reference stored in the "newWindow" variable.
+            Next, the window was directly added to the house, without any need to wrap the variable.
+            It basically works as one would expect it to work.
+            Finally, we notice that our house now has 2 windows.
         </para>
         <para>
-            However, we don't like the door, so let's change the door. To create a door, a color for that door needs to be picked. Color is of the Java Enum class type. Again as before, first the required variables need to be imported, new instances created and then the door of the house needs to be swapped out.
+            However, we don't like the door, so let's change the door. To create a door,
+            a color for that door needs to be picked. Color is of the Java Enum class type.
+            Again as before, first the required variables need to be imported,
+            new instances created and then the door of the house needs to be swapped out.
         </para>
         <screen>
-            -->jimport("com.foo.Color")
-
-            -->jimport("com.foo.Door")
-
-            -->newDoor = Door.new(Color.RED)
-            newDoor  =
+--> jimport("com.foo.Color")
 
-            com.foo.Door@54a5f709
+--> jimport("com.foo.Door")
 
-            -->house.replaceDoor(newDoor);
+--> newDoor = Door.new(Color.RED)
+newDoor  =
+com.foo.Door@54a5f709
 
-            -->house
-            house  =
+--> house.replaceDoor(newDoor);
 
-            This is a house painted in white, has a red door, and 2 windows
-        </screen>
+--> house
+house  =
+This is a house painted in white, has a red door, and 2 windows
+</screen>
         <para>
-            Using Enum types is as straightforward as using classes! Their methods and members are subject to the same principles:
+            Using Enum types is as straightforward as using classes! Their methods and members
+            are subject to the same principles:
         </para>
         <screen>
-            -->c = Color.random()
-            c  =
-
-            BLACK
-
-            -->c = Color.random()
-            c  =
-
-            BLUE
-
-            -->c.getDescr()
-            ans  =
-
-            blue
-        </screen>
+--> c = Color.random()
+c  =
+BLACK
+
+--> c = Color.random()
+c  =
+BLUE
+
+--> c.getDescr()
+ans  =
+blue
+</screen>
         <para>
-            The list of windows kept by that house is of type <literal>IWindow</literal>. From this it follows that under normal circumstances only windows may be added to the list. To test this, let's see what happens when a <literal>Door</literal> is added in Scilab.
+            The list of windows kept by that house is of type <literal>IWindow</literal>.
+            From this it follows that under normal circumstances only windows may be added to the list.
+            To test this, let's see what happens when a <literal>Door</literal> is added in Scilab.
         </para>
         <screen>
-            -->house.addWindow(newDoor);
-            !--error 999
-            Method invocation: An error occurred: Exception when calling Java method : No method addWindow in the class com.foo.House or bad arguments type.
-        </screen>
+--> house.addWindow(newDoor);
+!--error 999
+Method invocation: An error occurred: Exception when calling Java method : No method addWindow in the class com.foo.House or bad arguments type.
+</screen>
         <para>
-            The same as using Java Reflection, the JVM security measures prevent us from disobeying the Java polymorthism rules. The same goes for private methods and members.
+            The same as using Java Reflection, the JVM security measures prevent us from disobeying
+            the Java polymorthism rules. The same goes for private methods and members.
         </para>
         <screen>
-            -->c.descr
-            ans  =
-
-            blue
-
-            -->house.door
-            !--error 999
-            %_EObj_e: An error occurred: Exception when calling Java method : Invalid field door
+--> c.descr
+ans  =
+blue
 
-            -->house.repaint();
+--> house.door
+!--error 999
+%_EObj_e: An error occurred: Exception when calling Java method : Invalid field door
 
-            -->house
-            house  =
+--> house.repaint();
 
-            This is a house painted in red, has a white door, and 2 windows
+--> house
+house  =
+This is a house painted in red, has a white door, and 2 windows
 
-            -->house.swapDoorHouseColor()
-            !--error 999
-            %_EObj_e: An error occurred: Exception when calling Java method : Invalid field swapDoorHouseColor
-        </screen>
+--> house.swapDoorHouseColor()
+!--error 999
+%_EObj_e: An error occurred: Exception when calling Java method : Invalid field swapDoorHouseColor
+</screen>
         <para>
-            Concluding, the JIMS package does the job of hiding the Java JNI interface with Scilab, and make it very clear and transparent to use Java libraries under Scilab. All the normal JVM functionality is present and the Scilab syntax is clear and natural to use.
+            Concluding, the JIMS package does the job of hiding the Java JNI interface with Scilab,
+            and make it very clear and transparent to use Java libraries under Scilab.
+            All the normal JVM functionality is present and the Scilab syntax is clear and natural
+            to use.
         </para>
         <para>
-            From this point you should understand how to interface Scilab and Java libraries, utilize the full power of Java under the Scilab scripting environment.
+            From this point you should understand how to interface Scilab and Java libraries,
+            utilize the full power of Java under the Scilab scripting environment.
         </para>
     </refsection>
     <refsection>
@@ -335,7 +361,9 @@ jcompile(ls(directory + "/*.java"))
             <revision>
                 <revnumber>5.5.0</revnumber>
                 <revremark>
-                    Function introduced. Based on the 'JIMS' module. The main difference in the behavior compared to the JIMS module is that <link linkend="jautoUnwrap">jautoUnwrap</link> is enabled by default.
+                    Function introduced. Based on the 'JIMS' module. The main difference in the
+                    behavior compared to the JIMS module is that
+                    <link linkend="jautoUnwrap">jautoUnwrap</link> is enabled by default.
                 </revremark>
             </revision>
         </revhistory>
index 338dd5d..939423b 100644 (file)
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
 *
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2013 - S/E - Sylvestre Ledru
 * Copyright (C) 2012 - CNES - Simon Billemont
 *
- * 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.
+* 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" version="5.0-subset Scilab" xml:lang="ja" xml:id="jims-getting-started">
-
+<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" version="5.0-subset Scilab" xml:lang="ja"
+          xml:id="jims-getting-started">
     <refnamediv>
-
         <refname>入門 - 第1ステップ</refname>
-
         <refpurpose>Java Scilab バインディングを使用するには?</refpurpose>
-
     </refnamediv>
-
     <refsection>
-
         <title>説明</title>
-
         <para>
-
             このモジュールの目的は, Javaオブジェクトおよびデータ型を
-
             読込み, 相互作用を行えるようにすることです.
-
         </para>
-
     </refsection>
-
     <refsection>
-
         <title>基本</title>
-
         <para>
-
             始める前に, 多くの重要な関数とその動作を知っておくと良いでしょう.
-
             これらの多く使用される関数は, 以下のScilab関数です:
-
             <itemizedlist>
-
                 <listitem>
-
                     <link linkend="jimport">jimport</link>: Javaクラスをインポート
-
                 </listitem>
-
                 <listitem>
-
                     <link linkend="jimport">jinvoke</link>: Javaオブジェクトのメソッドをコール
-
                 </listitem>
-
             </itemizedlist>
-
         </para>
-
         <para>
-
             jimport はjava命令 'import' の機能を模擬する関数で,
-
             指定したクラス定義/指定したクラスのテンプレートをメモリに読込みます.
-
             読み込まれた際, この定義が静的メソッド/メンバへのアクセス,
-
             新規オブジェクト作成の際に使用されます.
-
             k
         </para>
-
         <para>
-
             jinvoke はjavaクラスまたはオブジェクトの指定したメソッドを
-
             コール(invoke)する関数です.
-
             このinvokeは,実際のメンバシグネチャと一致する
-
             一連のオプションのパラメータを有します.
-
             これは,同数のパラメータを指定し,これらの引数が正しい型を有している
-
             必要があることを意味します.
-
         </para>
-
     </refsection>
-
     <refsection>
-
         <title>例1: 基底クラスを作成し, 簡単なメソッドをコール</title>
-
         <para>
-
             この最初の例では,Javaを動作させる3つの基本的な柱を扱います.
-
             最初はクラスの読込みで,
-
             次はインスタンスの構築,
-
             最後はこのメソッドまたはメンバの一つをコールすることです.
-
         </para>
-
         <para>
-
             例<literal>HelloWorld</literal>で示されたものと同様の基底クラスを考えます.
-
             このクラスは,構築時にメッセージを生成するデフォルトのコンストラクタを有し,
-
             コール時にメッセージを表示する公開メソッドを1つ有します.
-
             このクラスは, javaバイトコードにコンパイルする必要があります.
-
             コードを開発する際には, この部分は通常IDE(integrated development environment)
-
             により処理されます.
-
             外部ライブラリを使用する場合, プリコンパイル形式(JARでパックされた)のものが
-
             利用可能です.
-
         </para>
-
         <programlisting role="java"><![CDATA[
 // HelloWorld.javaという名前で保存
 package com.foo;
@@ -144,560 +85,284 @@ public class HelloWorld {
    public HelloWorld() {
       System.err.println("HelloWorld constructed!");
   }
-
   public void message() {
       System.err.println("Hello world!");
   }
 }
       ]]></programlisting>
-
         <programlisting role="example"><![CDATA[
 // ScilabからJavaコードをコンパイルする方法
 javacode=mgetl(fullfile(TMPDIR, 'HelloWorld.java'));
 jcompile("com.foo.HelloWorld",javacode);
       ]]></programlisting>
-
         <para>
-
             このJavaクラスのコンパイル版が既に存在する場合, Scilabを起動し,
-
             Scilabに種々のメッセージを表示させることができます.
-
             HelloWorldクラスをワークスペースにインポートすることができます.
-
             これは, 前述のインポート手順により以下のように行うことができます:
-
             <screen>
 
-                -->jimport com.foo.HelloWorld
-
-
-
-                -->HelloWorld
+--> jimport com.foo.HelloWorld
 
-                HelloWorld  =
-
-
-
-                class com.foo.HelloWorld
-
-
-
-                -->whos -name HelloWorld
-
-                Name                     Type           Size           Bytes
-
-
-
-                HelloWorld               _EClass        ?              168
-
-            </screen>
+--> HelloWorld
+HelloWorld  =
+class com.foo.HelloWorld
 
+--> whos -name HelloWorld
+Name                     Type           Size           Bytes
+HelloWorld               _EClass        ?              168
+</screen>
             <para>
-
                 完了後, HelloWorldという名前の変数が作成されています.
-
                 これは, Javaにおけるクラスオブジェクトと等価です. このクラスオブジェクトから,
-
                 HelloWorld型の新規オブジェクトを作成できます.
-
             </para>
-
             <para>
-
                 オブジェクトのインスタンスの作成は,クラス定義に
-
                 <link linkend="new">new</link>を呼び出すことで行います.
-
                 このクラスの引数は, Javaコンストラクタに移譲されるパラメータです.
-
                 この処理の結果は, Javaオブジェクトへのリファレンスで,
-
                 後で使用するために変数に保存できます.
-
             </para>
-
             <screen>
 
-                -->object = HelloWorld.new();
+--> object = HelloWorld.new();
+HelloWorld constructed!
 
-                HelloWorld constructed!
-
-
-
-                -->object
-
-                object  =
-
-
-
-                com.foo.HelloWorld@49aacd5f
-
-
-
-                -->whos -name object
-
-                Name                     Type           Size           Bytes
-
-
-
-                object                   _EObj          ?              160
-
-            </screen>
+--> object
+object  =
+com.foo.HelloWorld@49aacd5f
 
+--> whos -name object
+Name                     Type           Size           Bytes
+object                   _EObj          ?              160
+</screen>
             <para>
-
                 <link linkend="new">new</link> 演算子が JClassでコールされた際,
-
                 Javaコンストラクタが透過的に呼び出され, メッセージ"HelloWorld constructed!"が
-
                 表示されます.
-
                 生成されたHelloWorld オブジェクトは"object"変数に保存されます.
-
                 このメッセージはHelloWorldクラスのtoStringメソッドをオーバーライドすることにより
-
                 カスタマイズできます.
-
             </para>
-
             <para>
-
                 ここで,特定のHelloWorldオブジェクトが作成され,
-
                 宣言された公開メソッドがを以下のようにコールできるようになりました;
-
                 <literal>HelloWorld\#message()</literal>.
-
                 <link linkend="new">new</link>と同様な技法を
-
                 メソッドを呼び出す際に使用できます:
-
             </para>
-
             <screen>
-
-                -->object.message();
-
-                Hello world!
-
-            </screen>
-
+--> object.message();
+Hello world!
+</screen>
             <para>
-
                 ドット演算子 (オブジェクトとメッセージの間にドット)は
-
                 便利なショートカットで,以下のようなScilabコードのスニペットを拡張します.
-
                 このショートカットの仕様により,
-
                 メソッドを呼び出したり,
-
                 メンバ変数を取得したりすることがより簡単かつ明快になります.
-
             </para>
-
             <screen>
-
-                -->jinvoke(object, 'message');
-
-                Hello world!
-
-            </screen>
-
+--> jinvoke(object, 'message');
+Hello world!
+</screen>
         </para>
-
     </refsection>
-
     <refsection>
-
         <title>例 2: Scilab と Java のプリミティブを相互変換</title>
-
         <para>
-
             この例は,基本的なデータ型と文字列をScilabとJavaの間で交換
-
             する手法を扱います.
-
             複数の型のオブジェクトをこれらの2つの言語の間で渡します.
-
         </para>
-
         <para>
-
             ここでは,例となるクラス(Class Inspector 参照)が
-
             オブジェクトを入出力するよう定義されます.
-
             2つのメソッドが定義されています.
-
             最初のメソッドは doubleを1つ引数とし,算術演算をして,
-
             結果を返します: Inspector#eval(double).
-
             もう一つのメソッドは, 任意のオブジェクトを引数とし,
-
             基本的な情報を表示して,返します: Inspector#inspect(Object).
-
         </para>
-
         <programlisting role="java"><![CDATA[
 // Inspector.java という名前で保存
 package com.foo;
 public class Inspector {
-       public double eval(double x) {
-               return x / 2.;
-       }
-
-       public Object inspect(Object prototype) {
-               System.err.println("Inspecting: '" + prototype + "'");
-               System.err.println("Class: " + prototype.getClass().getSimpleName());
-               return prototype;
-       }
+    public double eval(double x) {
+        return x / 2.;
+    }
+    public Object inspect(Object prototype) {
+        System.err.println("Inspecting: '" + prototype + "'");
+        System.err.println("Class: " + prototype.getClass().getSimpleName());
+        return prototype;
+    }
 }
       ]]></programlisting>
-
         <para>
-
             前の例と同様に, このコードは使用前にコンパイルしておく必要があります.
-
         </para>
-
         <programlisting role="example"><![CDATA[
 // Scilab から Javaコードをコンパイルする方法
 javacode= mgetl(fullfile(TMPDIR, 'Inspector.java'));
 jcompile("com.foo.Inspector",javacode);
       ]]></programlisting>
-
         まず, Inspectorクラスをインポートし,
-
         Inspectorオブジェクトを作成します:
-
         <screen>
-
-            -->jimport('com.foo.Inspector');
-
-
-
-            -->myInspector = Inspector.new()
-
-            myInspector  =
-
-
-
-            com.foo.Inspector@2a788315
-
-        </screen>
-
-        これにより, 2つのシステム間で情報を交換できるようになります.任意のScilabデータ型をJavaに指定すると, 自動的に Javaの等価な型にラップ(<link linkend="jwrap">jwrap</link>参照)されます.まず, Scilabで最も良く使用される型の使用例として, 実数(定数)を示します. 実数を渡すと, この型は自動的に Scilab型doubleにマップされます. 試してみましょう;
-
+--> jimport('com.foo.Inspector');
+
+--> myInspector = Inspector.new()
+myInspector  =
+com.foo.Inspector@2a788315
+</screen>
+        <para/>
+        これにより, 2つのシステム間で情報を交換できるようになります.任意のScilabデータ型をJavaに指定すると,
+        自動的に Javaの等価な型にラップ(<link linkend="jwrap">jwrap</link>参照)されます.まず,
+        Scilabで最も良く使用される型の使用例として, 実数(定数)を示します. 実数を渡すと, この型は自動的に
+        Scilab型doubleにマップされます. 試してみましょう;
         <screen>
-
-            -->result = myInspector.eval(12.5)
-
-            result  =
-
-
-
-            6.25
-
-
-
-            -->result * 2
-
-            ans  =
-
-
-
-            12.5
-
-
-
-            -->whos -name result
-
-            Name                     Type           Size           Bytes
-
-
-
-            result                   constant       1 by 1         24
-
-        </screen>
-
-        自動変換は, jautoUnwrap関数により制御されます. この関数を利用しない場合,全ての変換を陽に行う必要があります.
-
-        <screen>
-
-            -->result = myInspector.eval(12.5)
-
-            result  =
-
-
-
-            6.25
-
-
-
-            -->result * 2
-
-            ans  =
-
-
-
-            null
-
-
-
-            -->whos -name result
-
-            Name                     Type           Size           Bytes
-
-
-
-            result                   _EObj          ?              160
-
-        </screen>
-
-        返された結果は一見して正しいように見えます ($12.5/2=6.25$). しかし, よく見ると, 関数コールから返された値は数値ではありません. 受けたものは, 別の Javaオブジェクト (この場合は Double)です. 再びScilabで指定したデータを使用できるようにするには, jautoUnwrapを trueに設定していない場合, 前述の <link linkend="junwrap">junwrap</link>機能を使用できます.
-
+--> result = myInspector.eval(12.5)
+result  =
+6.25
+
+--> result * 2
+ans  =
+12.5
+
+--> whos -name result
+Name                     Type           Size           Bytes
+result                   constant       1 by 1         24
+</screen>
+        <para/>
+自動変換は, jautoUnwrap関数により制御されます. この関数を利用しない場合,全ての変換を陽に行う必要があります.
+<screen>
+--> result = myInspector.eval(12.5)
+result  =
+6.25
+
+--> result * 2
+ans  =
+null
+
+--> whos -name result
+Name                     Type           Size           Bytes
+result                   _EObj          ?              160
+</screen>
+        <para/>
+        返された結果は一見して正しいように見えます ($12.5/2=6.25$). しかし, よく見ると,
+        関数コールから返された値は数値ではありません. 受けたものは, 別の Javaオブジェクト (この場合は Double)です.
+        再びScilabで指定したデータを使用できるようにするには, jautoUnwrapを trueに設定していない場合, 前述の
+        <link linkend="junwrap">junwrap</link>機能を使用できます.
         この変換は Java型を等価な Scilab形式に戻します. これを行うと, 通常の数値を再度得ることができます:
-
         <screen>
-
-            -->result = junwrap(result)
-
-            result  =
-
-
-
-            6.25
-
-
-
-            -->whos -name result
-
-            Name                     Type           Size           Bytes
-
-
-
-            result                   constant       1 by 1         24
-
-
-
-            -->result * 2
-
-            ans  =
-
-
-
-            12.5
-
-        </screen>
-
-
-
-        この例から, doubleが Java VM により使用され,返される Doubleに自動的に変換される流れが明確になりました. 返された変数を指定して <link linkend="junwrap">junwrap</link>をコールした際, ネーティブなScilab型に戻されます.しかし, 他の型の場合はどうでしょう? 他の基本型についても調べてみましょう;
-
+--> result = junwrap(result)
+result  =
+6.25
+
+--> whos -name result
+Name                     Type           Size           Bytes
+result                   constant       1 by 1         24
+
+--> result * 2
+ans  =
+12.5
+</screen>
+        <para/>
+        この例から, doubleが Java VM により使用され,返される Doubleに自動的に変換される流れが明確になりました.
+        返された変数を指定して <link linkend="junwrap">junwrap</link>をコールした際, ネーティブなScilab型に戻されます.
+        しかし, 他の型の場合はどうでしょう? 他の基本型についても調べてみましょう;
         <screen>
-
-            -->jautoUnwrap(%f) // 自動unwrapを無効にします
-
-
-
-            -->result = myInspector.inspect("Hello world!");
-
-            Inspecting: 'Hello world!'
-
-            Class: String
-
-
-
-            -->whos -name result
-
-            Name                     Type           Size           Bytes
-
-
-
-            result                   _EObj          ?              160
-
-
-
-            -->result = junwrap(result)
-
-            result  =
-
-
-
-            Hello world!
-
-
-
-            -->whos -name result
-
-            Name                     Type           Size           Bytes
-
-
-
-            result                   string         1 by 1         72
-
-
-
-            // 整数
-
-            -->result = myInspector.inspect(int32(150));
-
-            Inspecting: '150'
-
-            Class: Integer
-
-
-
-            -->result = junwrap(result)
-
-            result  =
-
-
-
-            150
-
-
-
-            -->whos -name result
-
-            Name                     Type           Size           Bytes
-
-
-
-            result                   int32          1 by 1         40
-
-
-
-            // 論理値
-
-            -->result = myInspector.inspect(%t);
-
-            Inspecting: 'true'
-
-            Class: Boolean
-
-
-
-            -->result = junwrap(result)
-
-            result  =
-
-
-
-            T
-
-
-
-            -->whos -name result
-
-            Name                     Type           Size           Bytes
-
-
-
-            result                   boolean        1 by 1         16
-
-
-
-        </screen>
-
-
-
-        見てわかるように, 全ての関連するデータ型は Scilab と Java型の間で透過的に変換できます. しかし, これはそのまま行列にも拡張できます;
-
+--> jautoUnwrap(%f) // 自動unwrapを無効にします
+
+--> result = myInspector.inspect("Hello world!");
+Inspecting: 'Hello world!'
+Class: String
+
+--> whos -name result
+Name                     Type           Size           Bytes
+result                   _EObj          ?              160
+
+--> result = junwrap(result)
+result  =
+Hello world!
+
+--> whos -name result
+Name                     Type           Size           Bytes
+result                   string         1 by 1         72
+// 整数
+
+--> result = myInspector.inspect(int32(150));
+Inspecting: '150'
+Class: Integer
+
+--> result = junwrap(result)
+result  =
+150
+
+--> whos -name result
+Name                     Type           Size           Bytes
+result                   int32          1 by 1         40
+// 論理値
+
+--> result = myInspector.inspect(%t);
+Inspecting: 'true'
+Class: Boolean
+
+--> result = junwrap(result)
+result  =
+T
+
+--> whos -name result
+Name                     Type           Size           Bytes
+result                   boolean        1 by 1         16
+</screen>
+        <para/>
+        見てわかるように, 全ての関連するデータ型は Scilab と Java型の間で透過的に変換できます. しかし,
+        これはそのまま行列にも拡張できます;
         <screen>
-
-            --> jautoUnwrap(%t) // コールを自動unwrapするデフォルトのモードに戻します
-
-
-
-            -->result = myInspector.inspect(1:5)
-
-            Inspecting: '[D@b05236'
-
-            Class: double[]
-
-            result  =
-
-
-
-            1.    2.    3.    4.    5.
-
-
-
-            -->whos -name result
-
-            Name                     Type           Size           Bytes
-
-
-
-            result                   constant       1 by 5         56
-
-
-
-            -->result = myInspector.inspect(testmatrix('magi',3))
-
-            Inspecting: '[[D@11d13272'
-
-            Class: double[][]
-
-            result  =
-
-
-
-            8.    1.    6.
-
-            3.    5.    7.
-
-            4.    9.    2.
-
-
-
-            -->whos -name result
-
-            Name                     Type           Size           Bytes
-
-
-
-            result                   constant       3 by 3         88
-
-        </screen>
-
-        これらのラップされた行列のクラスを見ると, Javaはこれらを適当な大きさの配列として保存していることがわかります. 2次元行列の場合, これに等価なJava配列は列優先(デフォルト)または行優先モードで保存されます. 列優先モードでは, 最初の配列が各列へのポインタを有します. 一方, 行優先モードでは, 最初の配列が各行のデータを有します. 詳細については,<link linkend="jautoTranspose">jautoTranspose</link>を参照ください.
-
+-->  jautoUnwrap(%t) // コールを自動unwrapするデフォルトのモードに戻します
+
+--> result = myInspector.inspect(1:5)
+Inspecting: '[D@b05236'
+Class: double[]
+result  =
+1.    2.    3.    4.    5.
+
+--> whos -name result
+Name                     Type           Size           Bytes
+result                   constant       1 by 5         56
+
+--> result = myInspector.inspect(testmatrix('magi',3))
+Inspecting: '[[D@11d13272'
+Class: double[][]
+result  =
+8.    1.    6.
+3.    5.    7.
+4.    9.    2.
+
+--> whos -name result
+Name                     Type           Size           Bytes
+result                   constant       3 by 3         88
+</screen>
+        <para/>
+        これらのラップされた行列のクラスを見ると, Javaはこれらを適当な大きさの配列として保存していることがわかります.
+        2次元行列の場合, これに等価なJava配列は列優先(デフォルト)または行優先モードで保存されます.
+        列優先モードでは, 最初の配列が各列へのポインタを有します. 一方, 行優先モードでは, 最初の配列が各行のデータを有します.
+        詳細については,<link linkend="jautoTranspose">jautoTranspose</link>を参照ください.
     </refsection>
-
     <refsection>
-
         <title>履歴</title>
-
         <revhistory>
-
             <revision>
-
                 <revnumber>5.5.0</revnumber>
-
                 <revremark>
-
                     関数が導入されました. 'JIMS'モジュールに基づきます.
-
                     JIMSモジュールとの動作上の主な違いは,
-
                     <link linkend="jautoUnwrap">jautoUnwrap</link>がデフォルトで
-
                     有効になっていることです.
-
                 </revremark>
-
             </revision>
-
         </revhistory>
-
     </refsection>
-
 </refentry>
-
-
-
index 74e62a0..6df3da8 100644 (file)
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
 *
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2013 - S/E - Sylvestre Ledru
 * Copyright (C) 2012 - CNES - Simon Billemont
 *
- * 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.
+* 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" version="5.0-subset Scilab" xml:lang="ja" xml:id="jims-getting-started-2">
-
+<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" version="5.0-subset Scilab" xml:lang="ja"
+          xml:id="jims-getting-started-2">
     <refnamediv>
-
         <refname>入門 - 第2ステップ</refname>
-
         <refpurpose>Java Scilab バインディングを使用するには?</refpurpose>
-
     </refnamediv>
-
     <refsection>
-
         <title>説明</title>
-
         <para>
-
             このチュートリアルは,
-
             <link linkend="jims-getting-started">第1ステップ</link>の続きです.
-
         </para>
-
     </refsection>
-
     <refsection>
-
         <title>例 3: Scilabvで Java オブジェクトを使用する</title>
-
         <para>
-
             この例では,より高度に抽象化された一連のJavaオブジェクトを
-
             定義します. 次に, Javaスクリプト言語の一種としてScilabを使用して
-
             これらのオブジェクトに様々な操作を行います.
-
             以下の様なJavaの広範な機能を紹介します;
-
             staticメソッド (Factory construct), Enums, 簡単なポリモーフィズム,
-
             メンバ/メソッドのスコープ.
         </para>
-
         <para>
-
             この広範な機能は,簡単な家を記述する7つの簡単なクラスにより示されます;
-
         </para>
-
         <programlisting role="java"><![CDATA[
 // House.java という名前で保存
 package com.foo;
-
 import java.util.Arrays;
 import java.util.LinkendList;
 import java.util.List;
-
 public class House {
-
-       private Color                   color;
-       private Door                    door;
-       private List<IWindow>   windows = new LinkendList<IWindow>();
-
-       public House(Color color, Door door, IWindow... windows) {
-               this.color = color;
-               this.door = door;
-               this.windows.addAll(Arrays.asList(windows));
-       }
-
-       public void repaint() {
-               swapDoorHouseColor();
-       }
-
-       private void swapDoorHouseColor() {
-               Color doorColor = door.getColor();
-               door.repaint(color);
-               color = doorColor;
-       }
-
-       public void addWindow(IWindow window) {
-               windows.add(window);
-       }
-
-       public void replaceDoor(Door newDoor) {
-               this.door = newDoor;
-       }
-
-       @Override
-       public String toString() {
-               return String.format(
-                               "This is a house painted in %s, has a %s door, and %d windows",
-                               color.getDescr(), door.getColor().getDescr(), windows.size());
-       }
+    private Color           color;
+    private Door            door;
+    private List<IWindow>   windows = new LinkendList<IWindow>();
+    public House(Color color, Door door, IWindow... windows) {
+        this.color = color;
+        this.door = door;
+        this.windows.addAll(Arrays.asList(windows));
+    }
+    public void repaint() {
+        swapDoorHouseColor();
+    }
+    private void swapDoorHouseColor() {
+        Color doorColor = door.getColor();
+        door.repaint(color);
+        color = doorColor;
+    }
+    public void addWindow(IWindow window) {
+        windows.add(window);
+    }
+    public void replaceDoor(Door newDoor) {
+        this.door = newDoor;
+    }
+    @Override
+    public String toString() {
+        return String.format(
+                "This is a house painted in %s, has a %s door, and %d windows",
+                color.getDescr(), door.getColor().getDescr(), windows.size());
+    }
 }
       ]]></programlisting>
-
         <programlisting role="java"><![CDATA[
 package com.foo;
-
 public class HouseFactory {
-
-       public static House basicHouse() {
-               Door door = new Door(Color.WHITE);
-               IWindow window = new RectangularWindow(2, 0.8);
-               return new House(Color.WHITE, door, window);
-       }
-
-       public static House flashyHouse() {
-               Door door = new Door(Color.random());
-               IWindow window = new CircularWindow(1.2);
-               return new House(Color.random(), door, window);
-       }
+    public static House basicHouse() {
+        Door door = new Door(Color.WHITE);
+        IWindow window = new RectangularWindow(2, 0.8);
+        return new House(Color.WHITE, door, window);
+    }
+    public static House flashyHouse() {
+        Door door = new Door(Color.random());
+        IWindow window = new CircularWindow(1.2);
+        return new House(Color.random(), door, window);
+    }
 }
       ]]></programlisting>
-
         <programlisting role="java"><![CDATA[
-
 package com.foo;
-
 import java.util.Random;
-
 public enum Color {
-
-       BLACK("black"), BLUE("blue"), BROWN("brown"), GREEN("green"),
-       ORANGE("orange"), RED("red"), WHITE("white"), YELLOW("yellow");
-
-       public String   descr;
-
-       private Color(String s) {
-               descr = s;
-       }
-
-       public String getDescr() {
-               return descr;
-       }
-
-       public static Color random() {
-               Color[] allColors = values();
-               return allColors[new Random().nextInt(values().length)];
-       }
+    BLACK("black"), BLUE("blue"), BROWN("brown"), GREEN("green"),
+    ORANGE("orange"), RED("red"), WHITE("white"), YELLOW("yellow");
+    public String   descr;
+    private Color(String s) {
+        descr = s;
+    }
+    public String getDescr() {
+        return descr;
+    }
+    public static Color random() {
+        Color[] allColors = values();
+        return allColors[new Random().nextInt(values().length)];
+    }
 }      ]]></programlisting>
-
         <programlisting role="java"><![CDATA[
-
 package com.foo;
-
 public class Door {
-
-       private Color   color;
-
-       public Door(Color color) {
-               this.color = color;
-       }
-
-       public Color getColor() {
-               return color;
-       }
-
-       public void repaint(Color newColor) {
-               color = newColor;
-       }
+    private Color   color;
+    public Door(Color color) {
+        this.color = color;
+    }
+    public Color getColor() {
+        return color;
+    }
+    public void repaint(Color newColor) {
+        color = newColor;
+    }
 }
       ]]></programlisting>
-
         <programlisting role="java"><![CDATA[
 package com.foo;
-
 public interface IWindow {
-
-       double getWindowArea();
-
+    double getWindowArea();
 }
       ]]></programlisting>
-
         <programlisting role="java"><![CDATA[
 package com.foo;
-
 public class RectangularWindow implements IWindow {
-
-       double  length;
-       double  width;
-
-       public RectangularWindow(double length, double width) {
-               this.length = length;
-               this.width = width;
-       }
-
-       public double getWindowArea() {
-               return length * width;
-       }
+    double  length;
+    double  width;
+    public RectangularWindow(double length, double width) {
+        this.length = length;
+        this.width = width;
+    }
+    public double getWindowArea() {
+        return length * width;
+    }
 }
       ]]></programlisting>
-
         <programlisting role="java"><![CDATA[
 package com.foo;
-
 public class CircularWindow implements IWindow {
-
-       double  radius;
-
-       public CircularWindow(double radius) {
-               this.radius = radius;
-       }
-
-       public double getWindowArea() {
-               return Math.PI * radius * radius;
-       }
+    double  radius;
+    public CircularWindow(double radius) {
+        this.radius = radius;
+    }
+    public double getWindowArea() {
+        return Math.PI * radius * radius;
+    }
 }
       ]]></programlisting>
-
-
-
         <programlisting role="example"><![CDATA[
 // この例はScilabディストリビューションに含まれます.
 directory=SCI+"/modules/external_objects_java/examples/com/foo/"
 // これらを全てコンパイルします
 jcompile(ls(directory + "/*.java"))
       ]]></programlisting>
-
         <para>
-
             まず, 基本となるfactory houseを構築しましょう.
-
             このため, HouseFactory をインポートし, 静的メソッドbasicHouse()
-
             を呼び出す必要があります.
-
         </para>
-
         <screen>
+--> jimport("com.foo.HouseFactory")
 
-            -->jimport("com.foo.HouseFactory")
-
-
-
-            -->house = HouseFactory.basicHouse()
-
-            house  =
-
-
-
-            This is a house painted in white, has a white door, and 1 windows
-
-
-
-        </screen>
-
+--> house = HouseFactory.basicHouse()
+house  =
+This is a house painted in white, has a white door, and 1 windows
+</screen>
         <para>
-
             これは, 静的メソッドをJavaと同様にコールできることを示します.
-
             これは, "jinvoke(HouseFactory, 'basicHouse')"  と等価であることも
-
             頭に入れておいてください.
-
-
-
             オブジェクトのメッセージも以下のように交換できます:
-
-            <screen>
-
-                com.foo.House@ae8022
-
-                To
-
-                This is a house painted in white, has a white door, and 1 windows
-
-            </screen>
-
-            これは, Houseクラスが標準で \cmd[toString] メソッドを有するためです. この <literal>toString</literal>は,この表現を生成する際に使用されます. <link linkend="jgetclassname">jgetclassname</link> を呼び出すことにより, この場合も Houseオブジェクトの実際の型(クラス)を取得できます.
-
             <screen>
-
-                -->jgetclassname(house)
-
-                ans  =
-
-
-
-                com.foo.House
-
-            </screen>
-
-
-
+com.foo.House@ae8022
+To
+This is a house painted in white, has a white door, and 1 windows
+</screen>
+        <para/>
+        これは, Houseクラスが標準で \cmd[toString] メソッドを有するためです.
+        この <literal>toString</literal>は,この表現を生成する際に使用されます.
+        <link linkend="jgetclassname">jgetclassname</link> を呼び出すことにより,
+        この場合も Houseオブジェクトの実際の型(クラス)を取得できます.
+        <screen>
+--> jgetclassname(house)
+ans  =
+com.foo.House
+</screen>
+        <para/>
             更に興味深いのは,HouseをScilabに直接インポートせずに,家の説明が入手できたことです!
-
-            家が構築されたので,この家に別の窓を追加してみましょう. このため, 新しい窓を作成し,   <literal>addWindow(IWindow)</literal>関数により家に追加します. <literal>IWindow</literal>は窓に関する抽象化された説明で, 直接インスタンス化することはできません. しかし, 構築時に以下の2種類の実装が利用可能です; <literal>RectangularWindow</literal> および <literal>CircularWindow</literal>. この家は, factory で <literal>RectangularWindow</literal> を1つ付けているため, 新たに<literal>CircularWindow</literal>を作成してみましょう.
-
+            家が構築されたので,この家に別の窓を追加してみましょう. このため, 新しい窓を作成し,
+            <literal>addWindow(IWindow)</literal>関数により家に追加します.
+            <literal>IWindow</literal>は窓に関する抽象化された説明で, 直接インスタンス化することはできません.
+            しかし, 構築時に以下の2種類の実装が利用可能です; <literal>RectangularWindow</literal> および
+            <literal>CircularWindow</literal>. この家は, factory で
+            <literal>RectangularWindow</literal> を1つ付けているため,
+            新たに<literal>CircularWindow</literal>を作成してみましょう.
         </para>
-
         <screen>
+--> jimport("com.foo.IWindow")
 
-            -->jimport("com.foo.IWindow")
-
-
-
-            -->IWindow.new()
-
-            !--error 999
-
-            Method invocation: An error occurred: Exception when calling Java method : No such constructor in the class com.foo.IWindow.
-
-
-
-            -->jimport("com.foo.CircularWindow")
-
-
+--> IWindow.new()
+!--error 999
+Method invocation: An error occurred: Exception when calling Java method : No such constructor in the class com.foo.IWindow.
 
-            --> newWindow = CircularWindow.new(0.5)
+--> jimport("com.foo.CircularWindow")
 
-            newWindow  =
+-->  newWindow = CircularWindow.new(0.5)
+newWindow  =
+com.foo.CircularWindow@3e389405
 
+--> house.addWindow(newWindow);
 
-
-            com.foo.CircularWindow@3e389405
-
-
-
-            -->house.addWindow(newWindow);
-
-
-
-            -->house
-
-            house  =
-
-
-
-            This is a house painted in white, has a white door, and 2 windows
-
-
-
-        </screen>
-
+--> house
+house  =
+This is a house painted in white, has a white door, and 2 windows
+</screen>
         <para>
-
-            新しい窓が作成され, リファレンスが変数 "newWindow" に保存されました.次に, この窓が変数をラップすることを必要とせずに家に追加されました.これは通常予想される動作です.最後に, 家が2つの窓を有することを表示します.
-
+            新しい窓が作成され, リファレンスが変数 "newWindow" に保存されました.
+            次に, この窓が変数をラップすることを必要とせずに家に追加されました.
+            これは通常予想される動作です.最後に, 家が2つの窓を有することを表示します.
         </para>
-
         <para>
-
-            しかし, ドアが気に入らないため, ドアを変更してみましょう. ドアを作成するには, ドアの色を選ぶ必要があります. Color はJava Enum クラス型です. 前記と同様に, まず変数をインポートし,新規インスタンスを作成した後, 家のドアを交換します.
-
+            しかし, ドアが気に入らないため, ドアを変更してみましょう. ドアを作成するには, ドアの色を選ぶ必要があります.
+            Color はJava Enum クラス型です. 前記と同様に, まず変数をインポートし,新規インスタンスを作成した後,
+            家のドアを交換します.
         </para>
-
         <screen>
+--> jimport("com.foo.Color")
 
-            -->jimport("com.foo.Color")
-
-
-
-            -->jimport("com.foo.Door")
-
-
-
-            -->newDoor = Door.new(Color.RED)
-
-            newDoor  =
-
-
-
-            com.foo.Door@54a5f709
-
+--> jimport("com.foo.Door")
 
+--> newDoor = Door.new(Color.RED)
+newDoor  =
+com.foo.Door@54a5f709
 
-            -->house.replaceDoor(newDoor);
-
-
-
-            -->house
-
-            house  =
-
-
-
-            This is a house painted in white, has a red door, and 2 windows
-
-        </screen>
+--> house.replaceDoor(newDoor);
 
+--> house
+house  =
+This is a house painted in white, has a red door, and 2 windows
+</screen>
         <para>
-
             Enum型の使用はクラスと同様に簡単です! これらのメソッドとメンバは同じ方針に基づいています:
-
         </para>
-
         <screen>
-
-            -->c = Color.random()
-
-            c  =
-
-
-
-            BLACK
-
-
-
-            -->c = Color.random()
-
-            c  =
-
-
-
-            BLUE
-
-
-
-            -->c.getDescr()
-
-            ans  =
-
-
-
-            blue
-
-        </screen>
-
+--> c = Color.random()
+c  =
+BLACK
+
+--> c = Color.random()
+c  =
+BLUE
+
+--> c.getDescr()
+ans  =
+blue
+</screen>
         <para>
-
             家に保持される窓のリストは<literal>IWindow</literal>型
-
             です. これにより, リストに追加できるのは通常は窓のみです.
-
             これを確かめるため, Scilabで<literal>Door</literal>を
-
             追加するとどうなるかを見てみましょう.
-
         </para>
-
         <screen>
-
-            -->house.addWindow(newDoor);
-
-            !--error 999
-
-            Method invocation: An error occurred: Exception when calling Java method : No method addWindow in the class com.foo.House or bad arguments type.
-
-        </screen>
-
+--> house.addWindow(newDoor);
+!--error 999
+Method invocation: An error occurred: Exception when calling Java method : No method addWindow in the class com.foo.House or bad arguments type.
+</screen>
         <para>
-
             Java Reflectionを使用した場合と同様, JVM セキュリティ機構が,Javaポリモーフィズム規則に反することを防止するべく監視しています.
-
         </para>
-
         <screen>
+--> c.descr
+ans  =
+blue
 
-            -->c.descr
-
-            ans  =
-
-
-
-            blue
-
-
-
-            -->house.door
-
-            !--error 999
-
-            %_EObj_e: An error occurred: Exception when calling Java method : Invalid field door
-
-
-
-            -->house.repaint();
-
-
-
-            -->house
-
-            house  =
-
-
+--> house.door
+!--error 999
+%_EObj_e: An error occurred: Exception when calling Java method : Invalid field door
 
-            This is a house painted in red, has a white door, and 2 windows
+--> house.repaint();
 
+--> house
+house  =
+This is a house painted in red, has a white door, and 2 windows
 
-
-            -->house.swapDoorHouseColor()
-
-            !--error 999
-
-            %_EObj_e: An error occurred: Exception when calling Java method : Invalid field swapDoorHouseColor
-
-        </screen>
-
+--> house.swapDoorHouseColor()
+!--error 999
+%_EObj_e: An error occurred: Exception when calling Java method : Invalid field swapDoorHouseColor
+</screen>
         <para>
-
-            結論として, JIMSパッケージは Java JNIインターフェイスをScilab上で隠蔽する役割を担っており, これにより,非常に簡単にかつ透過的にScilabでJavaライブラリを使用することが可能です.全ての通常のJVM機能が存在し,Scilab構文は明確で直感的に使用できます.
-
+            結論として, JIMSパッケージは Java JNIインターフェイスをScilab上で隠蔽する役割を担っており,
+            これにより,非常に簡単にかつ透過的にScilabでJavaライブラリを使用することが可能です.
+            全ての通常のJVM機能が存在し,Scilab構文は明確で直感的に使用できます.
         </para>
-
         <para>
-
             ここまでで, ScilabとJavaライブラリを連携させ,
-
             Javaの全機能をScilabスクリプト環境で利用する
-
             方法を理解できたはずです.
-
         </para>
-
     </refsection>
-
     <refsection>
-
         <title>履歴</title>
-
         <revhistory>
-
             <revision>
-
                 <revnumber>5.5.0</revnumber>
-
                 <revremark>
-
                     関数が導入されました. 'JIMS'モジュールに基づきます.
-
                     JIMSモジュールとの動作上の主な違いは,
-
                     <link linkend="jautoUnwrap">jautoUnwrap</link>がデフォルトで
-
                     有効になっていることです.
-
                 </revremark>
-
             </revision>
-
         </revhistory>
-
     </refsection>
-
-</refentry>
-
-
-
+</refentry>
\ No newline at end of file
index 4bb2ec0..88c5e0f 100644 (file)
@@ -3,8 +3,8 @@
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2008 - INRIA
  * ...
- *
  * Copyright (C) 2012 - 2016 - Scilab Enterprises
+ * Copyright (C) 2019 - Samuel GOUGEON
  *
  * 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.
  * 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="en" xml:id="chdir">
+<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="chdir">
     <refnamediv>
         <refname>chdir</refname>
         <refpurpose>changes Scilab current directory</refpurpose>
@@ -25,7 +28,8 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Syntax</title>
-        <synopsis>b = chdir(path)
+        <synopsis>
+            b = chdir(path)
             realpath = cd(path)
             cd path
         </synopsis>
         <title>Arguments</title>
         <variablelist>
             <varlistentry>
-                <term>b</term>
+                <term>path</term>
                 <listitem>
-                    <para>
-                        a boolean  <constant>%t</constant> if <function>chdir</function> operation is ok
-                    </para>
+                  <para>a character string</para>. The default path is <literal>home</literal>.
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>path</term>
+                <term>b</term>
                 <listitem>
-                    <para>a character string</para>
+                    <para>
+                        a boolean:  <constant>%t</constant> if <function>chdir</function> operation
+                        is successful.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
         </para>
         <para>
             <note>
-                Note that path conversion is performed and for example
-                <literal>SCI/modules/core/macros</literal> is a valid pattern for both Unix and Windows.
-                If <varname>path</varname> is empty change to "home" directory.
+                Note that, if any, <link linkend="SCI">SCI</link>,
+                <link linkend="SCIHOME">SCIHOME</link>,
+                <link linkend="TMPDIR">TMPDIR</link> and
+                <link linkend="home">home</link> headings constants in path are  converted.
+                For example,  <literal>SCI/modules/core/macros</literal> is a valid pattern for
+                both Unix and Windows.
             </note>
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[
-chdir(TMPDIR);
+chdir("SCI/etc")
 pwd
-cd
-cd SCI
- ]]></programlisting>
+cd ..
+cd TMPDIR
+p = cd()
+p == home
+     ]]></programlisting>
+        <screen><![CDATA[
+--> chdir("SCI/etc")
+ ans  =
+  T
+
+--> pwd
+ ans  =
+ C:\Programs\scilab\scilab-6.0.2\etc
+
+
+--> cd ..
+ ans  =
+ C:\Programs\scilab\scilab-6.0.2
+
+--> cd TMPDIR
+ ans  =
+ C:\Users\Me\AppData\Local\Temp\SCI_TMP_5444_26901
+
+--> p = cd()
+ p  =
+ C:\Users\Me
+
+--> p == home
+ ans  =
+  T
+]]></screen>
     </refsection>
     <refsection role="see also">
         <title>See also</title>
         <simplelist type="inline">
             <member>
+                <link linkend="isdir">isdir</link>
+            </member>
+            <member>
                 <link linkend="pwd">pwd</link>
             </member>
             <member>
-                <link linkend="SCI">SCI</link>
+                <link linkend="home">home</link>
             </member>
             <member>
-                <link linkend="SCIHOME">SCIHOME</link>
+                <link linkend="filebrowser">filebrowser</link>
             </member>
             <member>
-                <link linkend="TMPDIR">TMPDIR</link>
+                <link linkend="uigetdir">uigetdir</link>
             </member>
         </simplelist>
     </refsection>
index 3148e2e..90d6075 100644 (file)
@@ -1,21 +1,39 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<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="fr" xml:id="chdir">
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2008 - INRIA
+ * ...
+ * Copyright (C) 2012 - 2016 - Scilab Enterprises
+ * Copyright (C) 2019 - Samuel GOUGEON
+ *
+ * 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="fr" xml:id="chdir">
     <refnamediv>
         <refname>chdir</refname>
-        <refpurpose>change le répertoire courant de
-            Scilab
+        <refpurpose>
+            change le répertoire courant de Scilab
         </refpurpose>
     </refnamediv>
     <refnamediv xml:id="cd">
         <refname>cd</refname>
-        <refpurpose>change le répertoire courant de
-            Scilab
+        <refpurpose>change le répertoire courant de Scilab
         </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Séquence d'appel</title>
-        <synopsis>chdir(path)
-            realpath=cd(path)
+        <synopsis>
+            b = chdir(path)
+            realpath = cd(path)
             cd path
         </synopsis>
     </refsynopsisdiv>
                 <term>path</term>
                 <listitem>
                     <para>une chaîne de caractères fournissant le chemin du
-                        répertoire.
+                      répertoire. <literal>home</literal> par défaut.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>b</term>
+                <listitem>
+                    <para>
+                        booléen :  <constant>%t</constant> si le changement de répertoire courant
+                        a été effectué avec succès.
                     </para>
                 </listitem>
             </varlistentry>
         </para>
         <para>
             <note>
-                Notez que le chemin fourni est converti. Ainsi
+                Notez que le chemin fourni est converti (constantes prédéfinis
+                <link linkend="SCI">SCI</link>,
+                <link linkend="SCIHOME">SCIHOME</link>,
+                <link linkend="TMPDIR">TMPDIR</link>,
+                <link linkend="home">home</link>, etc). Ainsi
                 <literal>SCI/modules/fileio/macros</literal> est un chemin valide pour Unix et Windows. Si
                 path est vide , le chemin de destination est alors "home".
             </note>
     <refsection>
         <title>Exemples</title>
         <programlisting role="example"><![CDATA[
-chdir(TMPDIR);
+chdir("SCI/etc")
 pwd
-cd
-cd SCI
- ]]></programlisting>
+cd ..
+cd TMPDIR
+p = cd()
+p == home
+     ]]></programlisting>
+        <screen><![CDATA[
+--> chdir("SCI/etc")
+ ans  =
+  T
+
+--> pwd
+ ans  =
+ C:\Programs\scilab\scilab-6.0.2\etc
+
+
+--> cd ..
+ ans  =
+ C:\Programs\scilab\scilab-6.0.2
+
+--> cd TMPDIR
+ ans  =
+ C:\Users\Me\AppData\Local\Temp\SCI_TMP_5444_26901
+
+--> p = cd()
+ p  =
+ C:\Users\Me
+
+--> p == home
+ ans  =
+  T
+]]></screen>
     </refsection>
     <refsection role="see also">
         <title>Voir aussi</title>
         <simplelist type="inline">
             <member>
+                <link linkend="isdir">isdir</link>
+            </member>
+            <member>
                 <link linkend="pwd">pwd</link>
             </member>
+            <member>
+                <link linkend="home">home</link>
+            </member>
+            <member>
+                <link linkend="filebrowser">filebrowser</link>
+            </member>
+            <member>
+                <link linkend="uigetdir">uigetdir</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
index f18feb8..a880be6 100644 (file)
@@ -1,5 +1,23 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<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="chdir">
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2008 - INRIA
+ * ...
+ * Copyright (C) 2012 - 2016 - Scilab Enterprises
+ * Copyright (C) 2019 - Samuel GOUGEON
+ *
+ * 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="chdir">
     <refnamediv>
         <refname>chdir</refname>
         <refpurpose>Scilab カレントディレクトリを変更する</refpurpose>
@@ -10,8 +28,9 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>呼び出し手順</title>
-        <synopsis>b=chdir(path)
-            realpath=cd(path)
+        <synopsis>
+            b = chdir(path)
+            realpath = cd(path)
             cd path
         </synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>例</title>
         <programlisting role="example"><![CDATA[
-chdir(TMPDIR);
+chdir("SCI/etc")
 pwd
-cd
-cd SCI
- ]]></programlisting>
+cd ..
+cd TMPDIR
+p = cd()
+p == home
+     ]]></programlisting>
+        <screen><![CDATA[
+--> chdir("SCI/etc")
+ ans  =
+  T
+
+--> pwd
+ ans  =
+ C:\Programs\scilab\scilab-6.0.2\etc
+
+
+--> cd ..
+ ans  =
+ C:\Programs\scilab\scilab-6.0.2
+
+--> cd TMPDIR
+ ans  =
+ C:\Users\Me\AppData\Local\Temp\SCI_TMP_5444_26901
+
+--> p = cd()
+ p  =
+ C:\Users\Me
+
+--> p == home
+ ans  =
+  T
+]]></screen>
     </refsection>
     <refsection role="see also">
         <title>参照</title>
         <simplelist type="inline">
             <member>
+                <link linkend="isdir">isdir</link>
+            </member>
+            <member>
                 <link linkend="pwd">pwd</link>
             </member>
+            <member>
+                <link linkend="home">home</link>
+            </member>
+            <member>
+                <link linkend="filebrowser">filebrowser</link>
+            </member>
+            <member>
+                <link linkend="uigetdir">uigetdir</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
index 0980d86..2116715 100644 (file)
@@ -1,5 +1,23 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<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="chdir" xml:lang="pt">
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2008 - INRIA
+ * ...
+ * Copyright (C) 2012 - 2016 - Scilab Enterprises
+ * Copyright (C) 2019 - Samuel GOUGEON
+ *
+ * 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: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="chdir" xml:lang="pt">
     <refnamediv>
         <refname>chdir</refname>
         <refpurpose>muda o diretório corrente do Scilab</refpurpose>
@@ -10,8 +28,9 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Seqüência de Chamamento</title>
-        <synopsis>b=chdir(path)
-            realpath=cd(path)
+        <synopsis>
+            b = chdir(path)
+            realpath = cd(path)
             cd path
         </synopsis>
     </refsynopsisdiv>
@@ -27,7 +46,7 @@
             <varlistentry>
                 <term>path</term>
                 <listitem>
-                    <para>um string</para>
+                    <para>um string</para>. O caminho padrão é <literal>home</literal>.
                 </listitem>
             </varlistentry>
             <varlistentry>
     <refsection>
         <title>Descrição</title>
         <para>Muda o diretório corrente do Scilab para aquele dado por
-            <literal>path</literal>. Note que a conversão de endereço é realizada e.
-            por exemplo <literal>SCI/modules/core/macros</literal> é um padrão válido
-            tanto pra Unix quanto para Windows. Se path for vazio, muda para diretório
-            "home".
+            <literal>path</literal>. Note que a conversão de endereço é realizada e
+            (<link linkend="SCI">SCI</link>,
+                <link linkend="SCIHOME">SCIHOME</link>,
+                <link linkend="TMPDIR">TMPDIR</link>,
+                <link linkend="home">home</link>, etc).
+            Por exemplo <literal>SCI/modules/core/macros</literal> é um padrão válido
+            tanto pra Unix quanto para Windows.
         </para>
     </refsection>
     <refsection>
         <title>Exemplos</title>
         <programlisting role="example"><![CDATA[
-chdir(TMPDIR);
+chdir("SCI/etc")
 pwd
-cd
-cd SCI
- ]]></programlisting>
+cd ..
+cd TMPDIR
+p = cd()
+p == home
+     ]]></programlisting>
+        <screen><![CDATA[
+--> chdir("SCI/etc")
+ ans  =
+  T
+
+--> pwd
+ ans  =
+ C:\Programs\scilab\scilab-6.0.2\etc
+
+
+--> cd ..
+ ans  =
+ C:\Programs\scilab\scilab-6.0.2
+
+--> cd TMPDIR
+ ans  =
+ C:\Users\Me\AppData\Local\Temp\SCI_TMP_5444_26901
+
+--> p = cd()
+ p  =
+ C:\Users\Me
+
+--> p == home
+ ans  =
+  T
+]]></screen>
     </refsection>
     <refsection>
         <title>Ver Também</title>
         <simplelist type="inline">
             <member>
+                <link linkend="isdir">isdir</link>
+            </member>
+            <member>
                 <link linkend="pwd">pwd</link>
             </member>
+            <member>
+                <link linkend="home">home</link>
+            </member>
+            <member>
+                <link linkend="filebrowser">filebrowser</link>
+            </member>
+            <member>
+                <link linkend="uigetdir">uigetdir</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
index 7582608..4045e50 100644 (file)
@@ -3,8 +3,8 @@
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2008 - INRIA
  * ...
- *
  * Copyright (C) 2012 - 2016 - Scilab Enterprises
+ * Copyright (C) 2019 - Samuel GOUGEON
  *
  * 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.
  * 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="chdir">
+<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="chdir">
     <info>
         <pubdate>$LastChangedDate$</pubdate>
     </info>
@@ -28,8 +31,9 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Синтаксис</title>
-        <synopsis>b=chdir(path)
-            realpath=cd(path)
+        <synopsis>
+            b = chdir(path)
+            realpath = cd(path)
             cd path
         </synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Примеры</title>
         <programlisting role="example"><![CDATA[
-chdir(TMPDIR);
+chdir("SCI/etc")
 pwd
-cd
-cd SCI
- ]]></programlisting>
+cd ..
+cd TMPDIR
+p = cd()
+p == home
+     ]]></programlisting>
+        <screen><![CDATA[
+--> chdir("SCI/etc")
+ ans  =
+  T
+
+--> pwd
+ ans  =
+ C:\Programs\scilab\scilab-6.0.2\etc
+
+
+--> cd ..
+ ans  =
+ C:\Programs\scilab\scilab-6.0.2
+
+--> cd TMPDIR
+ ans  =
+ C:\Users\Me\AppData\Local\Temp\SCI_TMP_5444_26901
+
+--> p = cd()
+ p  =
+ C:\Users\Me
+
+--> p == home
+ ans  =
+  T
+]]></screen>
     </refsection>
     <refsection role="see also">
         <title>Смотрите также</title>
         <simplelist type="inline">
             <member>
+                <link linkend="isdir">isdir</link>
+            </member>
+            <member>
                 <link linkend="pwd">pwd</link>
             </member>
             <member>
-                <link linkend="SCI">SCI</link>
+                <link linkend="home">home</link>
             </member>
             <member>
-                <link linkend="SCIHOME">SCIHOME</link>
+                <link linkend="filebrowser">filebrowser</link>
             </member>
             <member>
-                <link linkend="TMPDIR">TMPDIR</link>
+                <link linkend="uigetdir">uigetdir</link>
             </member>
         </simplelist>
     </refsection>
index b2989b0..faecbee 100644 (file)
@@ -35,7 +35,8 @@
         <para>
             <itemizedlist>
                 <listitem>
-                    Let U be the Z values of the plot for which a colorbar scale is needed, %inf, -%inf and %nan values being ignored.
+                    Let U be the Z values of the plot for which a colorbar scale is needed, %inf,
+                    -%inf and %nan values being ignored.
                 </listitem>
                 <listitem>
                     Let minU and maxU be the minimum and the maximum of U values.
@@ -96,7 +97,7 @@
                         represent the <literal>umin</literal> data value. Similarly,
                         the color of index <literal>colmax</literal> will represent
                         <literal>umax</literal>, with
-                        <literal>1 &lt; colmin &lt; colmax &lt; Nc</literal>.
+                        <literal>1 ≤ colmin &lt; colmax ≤ Nc</literal>.
                     </para>
                     <para>Default setting: <literal>[1,Nc]</literal></para>
                     <para>
         </para>
         <para><emphasis role="bold">colorbar(,, [colmin colmax])</emphasis></para>
         <para>
-            with integers such that <literal>1 colmin &lt; colmax Nc</literal>.
+            with integers such that <literal>1 ≤ colmin &lt; colmax ≤ Nc</literal>.
             Conversely to the previous one, this syntax sets
             <literal>umin</literal> and <literal>umax</literal>
             such that "[umin,umax]/[minU,maxU]" maps "[colmin,colmax]/[1,Nc]"
         </para>
         <para><emphasis role="bold">colorbar(,, [fmin fmax])</emphasis></para>
         <para>
-            The previous syntax <literal>colorbar(,,[colmin colmax])</literal> needs to know the colormap range to specify <literal>colmin</literal>
+            The previous syntax <literal>colorbar(,,[colmin colmax])</literal> needs to know the
+            colormap range to specify <literal>colmin</literal>
             and <literal>colmax</literal> conveniently. This is not very
             handy when we just want to target a fractional part of the colormap
             whatever is its actual length. <literal>fmin</literal> and
             This syntax sets
             <itemizedlist>
                 <listitem>
-                    <literal>umin</literal> and <literal>umax</literal> such that the relative range "[umin umax]/[min(U) max(U]" maps "[fmin, fmax]".
+                    <literal>umin</literal> and <literal>umax</literal> such that the relative
+                    range "[umin umax]/[min(U) max(U]" maps "[fmin, fmax]".
                 </listitem>
                 <listitem>
                     <literal>[colmin colmax]</literal> such that the relative range
index 56d3886..011080c 100644 (file)
  * 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="en" xml:id="name2rgb">
+<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="name2rgb">
     <refnamediv>
         <refname>name2rgb</refname>
         <refpurpose>returns the RGB values of a named color</refpurpose>
@@ -28,7 +31,7 @@
             <varlistentry>
                 <term>name</term>
                 <listitem>
-                    <para>name of the color or matrix with names of the colors.</para>
+                    <para>name of the color, or matrix with names of the colors (case insensitive).</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>name2rgb</literal> returns the RGB values of a color given by its name. The result is
-            a vector or a matrix with 3 columns <literal>[r,g,b]</literal> where <literal>r</literal>, <literal>g</literal> and <literal>b</literal> are integers between 0 and 255
+            <literal>name2rgb</literal> returns the RGB values of a color given by its literal name.
+            The result is
+            a vector or a matrix with 3 columns <literal>[r,g,b]</literal> where <literal>r</literal>,
+            <literal>g</literal> and <literal>b</literal> are integers between 0 and 255
             corresponding to colors components red, green and blue. As usual 0 means no intensity and
             255 means all the intensity of the color.
         </para>
index 3aaaa35..f1bdfef 100644 (file)
  * 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="en_US" xml:id="datatips">
+<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_US" xml:id="datatips">
     <refnamediv>
         <refname>datatips</refname>
         <refpurpose>Tool for placing and editing tips along the plotted curves</refpurpose>
         <title>See also</title>
         <simplelist type="inline">
             <member>
+                <link linkend="datatip_properties">datatip_properties</link>
+            </member>
+            <member>
                 <link linkend="datatipManagerMode">datatipManagerMode</link>
             </member>
             <member>
index 238537f..e4513c7 100644 (file)
  * 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="en" xml:id="object_editor">
+<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="object_editor">
     <refnamediv>
-        <refname>object editor </refname>
+        <refname>graphical editor</refname>
         <refpurpose>
-            description of the graphic object editor capacities
+            Interactive edition of hierarchical properties of graphic objects
         </refpurpose>
     </refnamediv>
     <refsection>
         <title>See also</title>
         <simplelist type="inline">
             <member>
-                <link linkend="graphics_entities">graphics_entities</link>
+                <link linkend="ieditor">ieditor</link>
             </member>
             <member>
-                <link linkend="set">set</link>
+                <link linkend="ged">ged</link>
             </member>
             <member>
-                <link linkend="get">get</link>
+                <link linkend="graphics_entities">graphics_entities</link>
             </member>
             <member>
-                <link linkend="clf">clf</link>
+                <link linkend="set">set</link>
             </member>
             <member>
-                <link linkend="plot">plot</link>
+                <link linkend="get">get</link>
             </member>
             <member>
-                <link linkend="ged">ged</link>
+                <link linkend="plot">plot</link>
             </member>
         </simplelist>
     </refsection>
index 7e56c6d..fdf3820 100644 (file)
@@ -1,9 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<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="fr" xml:id="object_editor">
+<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="fr" xml:id="object_editor">
     <refnamediv>
-        <refname>object_editor </refname>
-        <refpurpose>description des capacités de
-            l'éditeur graphique
+        <refname>Editeur graphique</refname>
+        <refpurpose>Edition interactive de l'arbre des propriétés des objets graphiques.
         </refpurpose>
     </refnamediv>
     <refsection>
         <title>Voir aussi</title>
         <simplelist type="inline">
             <member>
-                <link linkend="graphics_entities">graphics_entities</link>
+                <link linkend="ieditor">ieditor</link>
             </member>
             <member>
-                <link linkend="set">set</link>
+                <link linkend="ged">ged</link>
             </member>
             <member>
-                <link linkend="get">get</link>
+                <link linkend="graphics_entities">graphics_entities</link>
             </member>
             <member>
-                <link linkend="clf">clf</link>
+                <link linkend="set">set</link>
             </member>
             <member>
-                <link linkend="plot">plot</link>
+                <link linkend="get">get</link>
             </member>
             <member>
-                <link linkend="ged">ged</link>
+                <link linkend="plot">plot</link>
             </member>
         </simplelist>
     </refsection>
index 09b82f0..3b12c87 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) INRIA
-
  *
-
-
  * 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="ja" xml:id="name2rgb">
+<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="name2rgb">
 
     <refnamediv>
 
@@ -52,7 +49,7 @@
 
                 <listitem>
 
-                    <para>色の名前.</para>
+                    <para>色の名前 (case insensitive).</para>
 
                 </listitem>
 
index e582ff3..6447b89 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="ja" xml:id="datatips">
+<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="datatips">
 
     <refnamediv>
 
         <simplelist type="inline">
 
             <member>
+                <link linkend="datatip_properties">datatip_properties</link>
+            </member>
+            <member>
 
                 <link linkend="datatipToggle">datatipManagerMode</link>
 
index 0c0fae2..8d1877e 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="ja" xml:id="object_editor">
+<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="object_editor">
 
     <refnamediv>
 
         <title>参照o</title>
 
         <simplelist type="inline">
-
             <member>
-
+                <link linkend="ieditor">ieditor</link>
+            </member>
+            <member>
+                <link linkend="ged">ged</link>
+            </member>
+            <member>
                 <link linkend="graphics_entities">graphics_entities</link>
-
             </member>
-
             <member>
-
                 <link linkend="set">set</link>
-
             </member>
-
             <member>
-
                 <link linkend="get">get</link>
-
             </member>
-
             <member>
-
-                <link linkend="clf">clf</link>
-
-            </member>
-
-            <member>
-
                 <link linkend="plot">plot</link>
-
             </member>
-
         </simplelist>
 
     </refsection>
index ce6b8bb..173c0da 100644 (file)
  * 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="name2rgb" xml:lang="pt">
+<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="name2rgb" xml:lang="pt">
     <refnamediv>
         <refname>name2rgb</refname>
         <refpurpose>Retorna valores RGB correspondentes ao nome da
@@ -22,7 +25,7 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Seqüência de Chamamento</title>
-        <synopsis>rgb=name2rgb(name)</synopsis>
+        <synopsis>rgb = name2rgb(name)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Parâmetros</title>
@@ -30,7 +33,7 @@
             <varlistentry>
                 <term>name</term>
                 <listitem>
-                    <para>nome da cor </para>
+                    <para>nome da cor (insensível a maiúsculas).</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
index 8091bb2..43b6691 100644 (file)
  * 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: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="object_editor" xml:lang="pt">
+<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="object_editor" xml:lang="pt">
     <refnamediv>
         <refname>object_editor</refname>
         <refpurpose>Descrição das capacidades do editor de objetos
         <title>Ver Também</title>
         <simplelist type="inline">
             <member>
+                <link linkend="ieditor">ieditor</link>
+            </member>
+            <member>
+                <link linkend="ged">ged</link>
+            </member>
+            <member>
                 <link linkend="graphics_entities">graphics_entities</link>
             </member>
             <member>
                 <link linkend="get">get</link>
             </member>
             <member>
-                <link linkend="clf">clf</link>
-            </member>
-            <member>
                 <link linkend="plot">plot</link>
             </member>
         </simplelist>
index 29d28b5..670a49e 100644 (file)
@@ -1,8 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<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" version="5.0-subset Scilab" xml:lang="en" xml:id="ieditor">
+<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" version="5.0-subset Scilab"
+          xml:lang="en" xml:id="ieditor">
     <refnamediv>
         <refname>Interactive Editor</refname>
-        <refpurpose> Interactive plot editor</refpurpose>
+        <refpurpose>Interactive plot editor</refpurpose>
     </refnamediv>
     <refsection>
         <title>Description</title>
             </listitem>
         </itemizedlist>
     </refsection>
+    <refsection role="see also">
+        <title>See also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="object_editor">Properties editor</link>
+            </member>
+            <member>
+                <link linkend="ged">ged</link>
+            </member>
+            <member>
+                <link linkend="graphics_entities">graphics_entities</link>
+            </member>
+            <member>
+                <link linkend="set">set</link>
+            </member>
+            <member>
+                <link linkend="get">get</link>
+            </member>
+        </simplelist>
+    </refsection>
 </refentry>
index f967218..566bf16 100644 (file)
@@ -1,5 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<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" version="5.0-subset Scilab" xml:lang="ja" xml:id="ieditor">
+<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" version="5.0-subset Scilab"
+          xml:lang="ja" xml:id="ieditor">
     <refnamediv>
         <refname>対話型エディタ</refname>
         <refpurpose>対話型プロットエディタ</refpurpose>
             </listitem>
         </itemizedlist>
     </refsection>
+    <refsection role="see also">
+        <title>参照</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="object_editor">Properties editor</link>
+            </member>
+            <member>
+                <link linkend="ged">ged</link>
+            </member>
+            <member>
+                <link linkend="graphics_entities">graphics_entities</link>
+            </member>
+            <member>
+                <link linkend="set">set</link>
+            </member>
+            <member>
+                <link linkend="get">get</link>
+            </member>
+        </simplelist>
+    </refsection>
 </refentry>
index 24667a1..0e45bae 100644 (file)
@@ -1,12 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<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" version="5.0-subset Scilab" xml:lang="pt" xml:id="ieditor">
+<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" version="5.0-subset Scilab"
+          xml:lang="pt" xml:id="ieditor">
     <refnamediv>
         <refname>Editor Interativo</refname>
-        <refpurpose> Interactive plot editor</refpurpose>
+        <refpurpose>Interactive plot editor</refpurpose>
     </refnamediv>
     <refsection>
         <title>Description</title>
-
         <para>
             O editor interativo adiciona novas funcionalidades ao scilab, agora o usuário pode
             interagir com a janela de plot e os objetos graficos sem usar uma única linha de código.
             <listitem><para>
                     Copiar, recortar, colar
                 </para>
-                Entidades selecionadas podem ser copiadas ou recortadas e coladas em outras figuras (exceto legendas).
+                Entidades selecionadas podem ser copiadas ou recortadas e coladas
+                em outras figuras (exceto legendas).
                 <para>
-                    Para copiar ou recortar: selecione-a, click com o botão direito do mouse copiar/recortar.
+                    Para copiar ou recortar: selecione-a, click com o botão direito
+                    do mouse copiar/recortar.
                 </para>
                 <inlinemediaobject>
                     <imageobject>
             <listitem><para>
                     Copiar o estilo dos eixos
                 </para>
-                As propriedades dos eixos podem ser copiadas e coladas de uma figura para outra para facilitar a formatação.
+                As propriedades dos eixos podem ser copiadas e coladas de uma figura para outra
+                para facilitar a formatação.
                 <para>
-                    Para copiar o estilo do eixo: click com o botao direito do mouse sobre qualquer parte da figura e "copiar estilo".
+                    Para copiar o estilo do eixo: click com o botao direito do mouse sobre
+                    qualquer parte da figura e "copiar estilo".
                 </para>
                 <inlinemediaobject>
                     <imageobject>
             <listitem><para>
                     Copiar para a área de transferência
                 </para>
-                A figura pode ser copiada par a área de transferência do sistema, e colada em outros programas (como editores de texto e imagens que suportem).
+                A figura pode ser copiada par a área de transferência do sistema, e colada em
+                outros programas (como editores de texto e imagens que suportem).
                 <para>
-                    Para copiar a figura para a área de transferência: click com o botao direito do mouse, "Copiar para a área de transferência".
+                    Para copiar a figura para a área de transferência: click com o botao direito
+                    do mouse, "Copiar para a área de transferência".
                 </para>
                 <inlinemediaobject>
                     <imageobject>
                     Rotulos
                 </para>
                 <para>
-                    Com o simples click do botão direito o usuário pode inserir rotulos nos eixos, e com um click duplo sobre o texto de um rotulo abrir uma caixa de diálogo para editar o texto do mesmo.
+                    Com o simples click do botão direito o usuário pode inserir rotulos nos eixos,
+                    e com um click duplo sobre o texto de um rotulo abrir uma caixa de diálogo
+                    para editar o texto do mesmo.
                 </para>
                 <inlinemediaobject>
                     <imageobject>
                     Legendas
                 </para>
                 <para>
-                    Com o simples click do botão direito o usuário pode inserir uma legenda para a curva selecionada ou remover uma legenda existente dessa curva, e com um click duplo sobre uma legenda abrir uma caixa de dialogo para edita o texto do mesmo.
+                    Com o simples click do botão direito o usuário pode inserir uma legenda para
+                    a curva selecionada ou remover uma legenda existente dessa curva,
+                    e com um click duplo sobre uma legenda abrir uma caixa de dialogo
+                    para edita o texto do mesmo.
                 </para>
                 <inlinemediaobject>
                     <imageobject>
             <listitem><para>
                     Abrir GED(Janela de Propriedades)
                 </para>
-                Com o simples click do botão direito o usuario pode abrir a ged com as propriedades da entidade selecionada.
+                Com o simples click do botão direito o usuario pode abrir a ged com as
+                propriedades da entidade selecionada.
             </listitem>
 
         </itemizedlist>
                     Editor gráfico de curvas
                 </para>
                 <para>
-                    Para editar os dados de uma curva: Habilite o modo de edição de dados, selecione um objeto, click com o botão direito, "editar dados da curva" ou dê um click duplo sobre a curva.
+                    Para editar os dados de uma curva: Habilite o modo de edição de dados,
+                   selecione um objeto, click com o botão direito, "editar dados da curva"
+                  ou dê um click duplo sobre a curva.
                 </para>
                 <inlinemediaobject>
                     <imageobject>
                     </imageobject>
                 </inlinemediaobject>
                 <para>
-                    Para adicionar um ponto a curva: com a curva selecionada e o modo de edição de dados habilitado, click com o botão direito, inserir ou dê um click duplo sobre a curva na posição onde deseja adicionar o ponto.
+                    Para adicionar um ponto a curva: com a curva selecionada e o modo de edição
+                   de dados habilitado, click com o botão direito, inserir ou dê um click duplo
+                  sobre a curva na posição onde deseja adicionar o ponto.
                 </para>
                 <para>
-                    Para remover um ponto: com a curva selecionada e o modo de edição de dados habilitado, click com o botao direito sobre o ponto, "remover".
+                    Para remover um ponto: com a curva selecionada e o modo de edição de dados
+                   habilitado, click com o botao direito sobre o ponto, "remover".
                 </para>
                 <inlinemediaobject>
                     <imageobject>
                     </imageobject>
                 </inlinemediaobject>
                 <para>
-                    Para mover um ponto: com a curva selecionada e o modo de edição de dados habilitado, click e arraste o ponto.
+                    Para mover um ponto: com a curva selecionada e o modo de edição de dados
+                    habilitado, click e arraste o ponto.
                 </para>
                 <inlinemediaobject>
                     <imageobject>
             </listitem>
         </itemizedlist>
     </refsection>
+    <refsection role="see also">
+        <title>Ver também</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="object_editor">Properties editor</link>
+            </member>
+            <member>
+                <link linkend="ged">ged</link>
+            </member>
+            <member>
+                <link linkend="graphics_entities">graphics_entities</link>
+            </member>
+            <member>
+                <link linkend="set">set</link>
+            </member>
+            <member>
+                <link linkend="get">get</link>
+            </member>
+        </simplelist>
+    </refsection>
 </refentry>
index c7028a5..ee8a7e7 100644 (file)
@@ -10,5 +10,5 @@
 // For more information, see the COPYING file which you should have received
 // along with this program.
 
-add_help_chapter("Localization",SCI+"/modules/localization/help/en_US",%T);
+add_help_chapter("Multilinguism",SCI+"/modules/localization/help/en_US",%T);
 
index d56a2da..ce0afdb 100644 (file)
@@ -3,9 +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) 2018 - Samuel GOUGEON
- *
  * Copyright (C) 2012 - 2016 - Scilab Enterprises
+ * Copyright (C) 2018 - Samuel GOUGEON
  *
  * 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.
                             </tr>
                             <tr valign="top">
                                 <th>2</th>
-                                <td style="white-space:pre"><literal>
+                                <td style="white-space:pre"><screen><![CDATA[
 msg = "To be translated";
-gettext(msg)</literal>
+gettext(msg)]]></screen>
                                 </td>
                                 <td>NOK</td>
                                 <td>
@@ -176,9 +175,9 @@ gettext(msg)</literal>
                             </tr>
                             <tr valign="top">
                                 <th>4</th>
-                                <td style="white-space:pre"><literal>
+                                <td style="white-space:pre"><screen><![CDATA[
 gettext("To be" + ..
-                  " translated")</literal>
+        " translated")]]></screen>
                                 </td>
                                 <td>NOK</td>
                                 <td>Same as #3</td>
@@ -205,9 +204,9 @@ gettext("To be" + ..
                             </tr>
                             <tr valign="top">
                                 <th>7</th>
-                                <td style="white-space:pre"><literal>
+                                <td style="white-space:pre"><screen><![CDATA[
 gettext(["item#1"
-         "item#2"])</literal>
+         "item#2"])]]></screen>
                                 </td>
                                 <td>NOK</td>
                                 <td>Same as #6</td>
@@ -222,9 +221,9 @@ gettext(["item#1"
                             </tr>
                             <tr valign="top">
                                 <th>9</th>
-                                <td style="white-space:pre"><literal>
+                                <td style="white-space:pre"><screen><![CDATA[
 gettext(["item#1" ;
-         "item#2"])</literal>
+         "item#2"])]]></screen>
                                 </td>
                                 <td>OK</td>
                                 <td>
@@ -246,6 +245,7 @@ gettext(["item#1" ;
                             <literal>addlocalizationdomain()</literal>
                         </para>
                     </important>
+                    <para/>
                 </listitem>
                 <listitem>
                     <para>
@@ -253,6 +253,7 @@ gettext(["item#1" ;
                         contributors. Anyway, by some humans. Good translation tools are also available
                         online.
                     </para>
+                    <para/>
                 </listitem>
                 <listitem>
                     <para>
@@ -261,6 +262,7 @@ gettext(["item#1" ;
                         This is done by running <literal>tbx_generate_pofile()</literal> another
                         time.
                     </para>
+                    <para/>
                 </listitem>
                 <listitem>
                     <para>
@@ -337,10 +339,20 @@ gettext(["item#1" ;
                         </para>
                         <warning>
                             When <literal>gettext()</literal> or <literal>_()</literal> is used in
-                            an XML file such as in the preferences files of an external module, the
-                            literal domain string and the literal message id must no longer be
-                            delimited. For instance, <literal>_(my_domain, My message)</literal>
+                            a XML or XSL file such as in the preferences files of an external module,
+                            the literal domain string and the literal message id must no longer be
+                            delimited.
+                            <para/>
+                            For instance, <literal>_(my_domain, My message)</literal>
                             will be used instead of <literal>_("my_domain", "My message")</literal>.
+                            <para>
+                                In addition, spaces before and after the messageID are then never
+                                taken into account and never belong to the message. For example,
+                                the actual message ID corresponding to
+                                <literal>_(my_domain, My message:  )</literal> is
+                                <literal>"My message:"</literal>, not
+                                <literal>" My message:  "</literal>.
+                            </para>
                         </warning>
                     </listitem>
                     <listitem>
@@ -358,7 +370,7 @@ gettext(["item#1" ;
                     <listitem>
                         <para>
                             Some template messages may often include some "%" C-like directives
-                            aiming to be replaced with some input custom data through
+                            aiming to be replaced with some custom input data through
                             <literal>msprintf()</literal> at run time.
                             For instance,
                             <literal>msprintf("Hi %s, could you come at %s today?", "John", "12:30")</literal>
index 6241747..4e94556 100644 (file)
@@ -10,5 +10,5 @@
 // For more information, see the COPYING file which you should have received
 // along with this program.
 
-add_help_chapter("Localisation",SCI+"/modules/localization/help/fr_FR",%T);
+add_help_chapter("Multilinguisme",SCI+"/modules/localization/help/fr_FR",%T);
 
index 5560693..d7ed8a1 100644 (file)
  * 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="en" xml:id="About_M2SCI_tools">
+<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="About_M2SCI_tools">
     <refnamediv>
         <refname>About M2SCI tools</refname>
         <refpurpose>Generally speaking about tools to convert Matlab files to Scilab</refpurpose>
@@ -23,7 +26,7 @@
         <para>Scilab includes useful tools to convert Matlab M-files to Scilab.</para>
         <para>
             Taking a Matlab M-file, <literal>mfile2sci</literal> modifies this files so that it can be
-            compiled by Scilab. After that this compiled code is converted to a "tree" of instructions
+            compiled by Scilab. Then, this compiled code is converted to a "tree" of instructions
             by <literal>macr2tree</literal>. This "tree" is an imbrication of Scilab lists and tlists and
             is the basis for conversion. Each instruction of this "tree" is converted to Scilab and
             inference is done to known what are the variables. Once this "tree" is converted to Scilab,
             Function calls are converted using a function called <literal>sci_&lt;Matlab_function_name&gt;</literal>.
             Some of these functions have been written and are in directory SCI/modules/m2sci/macros/sci_files/.
             We are working on increasing the set of Matlab functions converted. However, everybody can
-            written such functions using help page sci_files.
+            write such functions using help page sci_files.
         </para>
         <para>
             Inference is done using tlists of type "infer" containing fields:
         </para>
-        <itemizedlist>
+        <variablelist>
+          <varlistentry>
+            <term>dims</term>
             <listitem>
-                <variablelist>
-                    <varlistentry>
-                        <term>dims</term>
-                        <listitem>
-                            <para>list of dimensions</para>
-                        </listitem>
-                    </varlistentry>
-                    <varlistentry>
-                        <term>type</term>
-                        <listitem>
-                            <para>"type" tlist</para>
-                        </listitem>
-                    </varlistentry>
-                    <varlistentry>
-                        <term>contents</term>
-                        <listitem>
-                            <para>"contents" tlist if a Cell or a Struct</para>
-                        </listitem>
-                    </varlistentry>
-                </variablelist>
+              <para>list of dimensions</para>
             </listitem>
-        </itemizedlist>
+          </varlistentry>
+          <varlistentry>
+            <term>type</term>
+            <listitem>
+              <para>"type" tlist</para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>contents</term>
+            <listitem>
+              <para>"contents" tlist if a Cell or a Struct</para>
+            </listitem>
+          </varlistentry>
+        </variablelist>
         <para>
             Type is a tlist of type "type" containing fields:
         </para>
-        <itemizedlist>
+        <variablelist>
+          <varlistentry>
+            <term>vtype</term>
             <listitem>
-                <variablelist>
-                    <varlistentry>
-                        <term>vtype</term>
-                        <listitem>
-                            <para>data type</para>
-                        </listitem>
-                    </varlistentry>
-                    <varlistentry>
-                        <term>property</term>
-                        <listitem>
-                            <para>property</para>
-                        </listitem>
-                    </varlistentry>
-                </variablelist>
+              <para>data type</para>
             </listitem>
-        </itemizedlist>
+          </varlistentry>
+          <varlistentry>
+            <term>property</term>
+            <listitem>
+              <para>property</para>
+            </listitem>
+          </varlistentry>
+        </variablelist>
         <para>To have more details about inference see help page for m2scideclare.</para>
     </refsection>
     <refsection role="see also">
index a9bb4e9..acabb69 100644 (file)
  * 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:id="m2sci_horzcat">
+<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:id="m2sci_horzcat">
     <refnamediv>
         <refname>horzcat (Matlab function)</refname>
         <refpurpose>Horizontal concatenation</refpurpose>
                 <td align="center">
                     <emphasis role="bold">Scilab</emphasis>
                 </td>
+                <td/>
             </tr>
             <tr>
                 <td>
-                    <programlisting role="example"><![CDATA[
-horzcat
-]]></programlisting>
+                    <screen><![CDATA[
+horzcat(A, B,..)
+]]></screen>
+                </td>
+                <td>
+                    <screen><![CDATA[
+cat(2, A, B,..)
+[A, B, ..]
+]]></screen>
                 </td>
                 <td>
                     <programlisting role="example"><![CDATA[
-No equivalent
+m = [1:4 ; 5:8; 9:12]'
+cat(2, m, m)
+[m ; m]
+
+h = matrix(m,2,3,2)
+cat(2, h, h)
+[h ; h]
 ]]></programlisting>
                 </td>
             </tr>
         </informaltable>
     </refsection>
-    <refsection>
-        <title>Particular cases</title>
-        <para>
-            Scilab equivalent for Matlab <emphasis role="bold">horzcat(A1,A2,...,An)</emphasis> is <emphasis role="bold">[A1,A2,...,An]</emphasis> if all <emphasis role="bold">Ai</emphasis> are not character strings, else, Scilab equivalent is <emphasis role="bold">A1+A2+...+An</emphasis>.
-        </para>
-    </refsection>
 </refentry>
index 73fca99..a726b63 100644 (file)
  * 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:id="m2sci_isa">
+<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:id="m2sci_isa">
     <refnamediv>
         <refname>isa (Matlab function)</refname>
         <refpurpose>Detect an object of a given type</refpurpose>
@@ -25,7 +28,6 @@
             function in Scilab but it can be replaced by equivalent syntaxes as shown is examples.
         </para>
         <table>
-            <caption/>
             <tbody>
                 <tr>
                     <td>
index ea02213..bd2b391 100644 (file)
  * 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:id="m2sci_randperm">
+<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:id="m2sci_randperm">
     <refnamediv>
         <refname>randperm (Matlab function)</refname>
         <refpurpose>Uniformly distributed random numbers and arrays</refpurpose>
                 <td align="center">
                     <emphasis role="bold">Scilab</emphasis>
                 </td>
+                <td/>
             </tr>
             <tr>
                 <td>
-                    <programlisting role="example"><![CDATA[
-randperm(n) ; randperm(n ,k)
-]]></programlisting>
+                    <screen><![CDATA[
+randperm(n)
+randperm(n, m)
+]]></screen>
+                </td>
+                <td>
+                    <screen><![CDATA[
+grand(1, "prm", 1:n)
+grand(1, "prm", 1:n)(1:m)
+]]></screen>
                 </td>
                 <td>
                     <programlisting role="example"><![CDATA[
-grand(1, "prm", (1:n)')' ; v = grand(1, "prm", (1:n)')', v(1:k)
+grand(1, "prm", 1:10)
+grand(1, "prm", 1:10)(1:6)
 ]]></programlisting>
                 </td>
             </tr>
         </informaltable>
     </refsection>
-    <refsection>
-        <title>Description</title>
-        <para>
-            Matlab's randperm(n) is equivalent to grand(1, "prm", (1:n)')' in Scilab.
-        </para>
-        <para>
-            randperm(n, k) corresponds to the k first elements of the above command, so the equivalent is stored in v(1:k), if v = grand(1, "prm", (1:n)')'.
-        </para>
-    </refsection>
 </refentry>
index dc29789..7525c40 100644 (file)
  * 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:id="m2sci_vertcat">
+<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:id="m2sci_vertcat">
     <refnamediv>
         <refname>vertcat (Matlab function)</refname>
         <refpurpose>Vertical concatenation</refpurpose>
                 <td align="center">
                     <emphasis role="bold">Scilab</emphasis>
                 </td>
+                <td/>
             </tr>
             <tr>
                 <td>
-                    <programlisting role="example"><![CDATA[
-vertcat
-]]></programlisting>
+                    <screen><![CDATA[
+vertcat(A, B,..)
+]]></screen>
+                </td>
+                <td>
+                    <screen><![CDATA[
+cat(1, A, B,..)
+[A ; B ; ..]
+]]></screen>
                 </td>
                 <td>
                     <programlisting role="example"><![CDATA[
-No equivalent
+m = [1:6 ; 7:12]
+cat(1, m, m, m)
+[m ; m]
+
+h = matrix(m,2,3,2)
+cat(1, h, h)
+[h ; h]
 ]]></programlisting>
                 </td>
             </tr>
         </informaltable>
     </refsection>
-    <refsection>
-        <title>Particular cases</title>
-        <para>
-            Scilab equivalent for Matlab <emphasis role="bold">vertcat(A1,A2,...,An)</emphasis> is <emphasis role="bold">[A1;A2;...;An]</emphasis>.
-        </para>
-    </refsection>
 </refentry>
index 4da5d01..d2595d7 100644 (file)
  * 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="en" xml:id="m2scideclare">
+<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="m2scideclare">
     <refnamediv>
         <refname>m2scideclare</refname>
         <refpurpose>Giving tips to help M2SCI...</refpurpose>
         <para>
             with :
         </para>
-        <itemizedlist>
+          <itemizedlist>
             <listitem>
-                <itemizedlist>
-                    <listitem>
-                        <para>
-                            variable_name: name of the variable declared. It can be a Struct field (e.g. <literal>x(1,2).name</literal>)
-                            or describe the contents of a Cell using syntax
-                            <literal>x(1,2).entries</literal>. NOTE that for Cells and Structs,
-                            <literal>*</literal> can be used as an index (see examples below).
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            dimensions: dimensions of the variable declared separated by blanks, if a dimension is unknown,
-                            replace it by <literal>?</literal>. NOTE that String dimensions must be similar to Matlab ones
-                            e.g. <literal>1 6</literal> for character string 'string'.
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            data_type: data type of the variable which can be:
-                        </para>
-                        <informaltable border="1">
-                            <tr>
-                                <td>m2scideclare data type</td>
-                                <td>Scilab "equivalent" type</td>
-                            </tr>
-                            <tr>
-                                <td>Double</td>
-                                <td>1</td>
-                            </tr>
-                            <tr>
-                                <td>Boolean</td>
-                                <td>4</td>
-                            </tr>
-                            <tr>
-                                <td>Sparse</td>
-                                <td>5</td>
-                            </tr>
-                            <tr>
-                                <td>Int</td>
-                                <td>8</td>
-                            </tr>
-                            <tr>
-                                <td>Handle</td>
-                                <td>9</td>
-                            </tr>
-                            <tr>
-                                <td>String</td>
-                                <td>10</td>
-                            </tr>
-                            <tr>
-                                <td>Struct</td>
-                                <td>Matlab struct (16)</td>
-                            </tr>
-                            <tr>
-                                <td>Cell</td>
-                                <td>Matlab cell (17)</td>
-                            </tr>
-                            <tr>
-                                <td>Void</td>
-                                <td>No type (0)</td>
-                            </tr>
-                            <tr>
-                                <td>?</td>
-                                <td>Unknown type</td>
-                            </tr>
-                        </informaltable>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            property: property of the variable which can be:
-                        </para>
-                        <informaltable border="1">
-                            <tr>
-                                <td>m2scideclare property</td>
-                                <td>Scilab "equivalent"</td>
-                            </tr>
-                            <tr>
-                                <td>Real</td>
-                                <td>Real data</td>
-                            </tr>
-                            <tr>
-                                <td>Complex</td>
-                                <td>Complex data</td>
-                            </tr>
-                            <tr>
-                                <td>?</td>
-                                <td>Unknown property</td>
-                            </tr>
-                        </informaltable>
-                        <para>
-                            This field is ignored for following datatypes: <literal>Cell</literal>,
-                            <literal>Struct</literal>, <literal>String</literal> and <literal>Boolean</literal>.
-                        </para>
-                    </listitem>
-                </itemizedlist>
+              <para>
+                variable_name: name of the variable declared. It can be a Struct field (e.g. <literal>x(1,2).name</literal>)
+                or describe the contents of a Cell using syntax
+                <literal>x(1,2).entries</literal>. NOTE that for Cells and Structs,
+                <literal>*</literal> can be used as an index (see examples below).
+              </para>
             </listitem>
-        </itemizedlist>
+            <listitem>
+              <para>
+                dimensions: dimensions of the variable declared separated by blanks, if a dimension is unknown,
+                replace it by <literal>?</literal>. NOTE that String dimensions must be similar to Matlab ones
+                e.g. <literal>1 6</literal> for character string 'string'.
+              </para>
+            </listitem>
+            <listitem>
+              <para>
+                data_type: data type of the variable which can be:
+              </para>
+              <informaltable border="1">
+                <tr>
+                  <td>m2scideclare data type</td>
+                  <td>Scilab "equivalent" type</td>
+                </tr>
+                <tr>
+                  <td>Double</td>
+                  <td>1</td>
+                </tr>
+                <tr>
+                  <td>Boolean</td>
+                  <td>4</td>
+                </tr>
+                <tr>
+                  <td>Sparse</td>
+                  <td>5</td>
+                </tr>
+                <tr>
+                  <td>Int</td>
+                  <td>8</td>
+                </tr>
+                <tr>
+                  <td>Handle</td>
+                  <td>9</td>
+                </tr>
+                <tr>
+                  <td>String</td>
+                  <td>10</td>
+                </tr>
+                <tr>
+                  <td>Struct</td>
+                  <td>Matlab struct (16)</td>
+                </tr>
+                <tr>
+                  <td>Cell</td>
+                  <td>Matlab cell (17)</td>
+                </tr>
+                <tr>
+                  <td>Void</td>
+                  <td>No type (0)</td>
+                </tr>
+                <tr>
+                  <td>?</td>
+                  <td>Unknown type</td>
+                </tr>
+              </informaltable>
+            </listitem>
+            <listitem>
+              <para>
+                property: property of the variable which can be:
+              </para>
+              <informaltable border="1">
+                <tr>
+                  <td>m2scideclare property</td>
+                  <td>Scilab "equivalent"</td>
+                </tr>
+                <tr>
+                  <td>Real</td>
+                  <td>Real data</td>
+                </tr>
+                <tr>
+                  <td>Complex</td>
+                  <td>Complex data</td>
+                </tr>
+                <tr>
+                  <td>?</td>
+                  <td>Unknown property</td>
+                </tr>
+              </informaltable>
+              <para>
+                This field is ignored for following datatypes: <literal>Cell</literal>,
+                <literal>Struct</literal>, <literal>String</literal> and <literal>Boolean</literal>.
+              </para>
+            </listitem>
+          </itemizedlist>
         <para>
             All data given by <literal>m2scideclare</literal> are compared with infered data,
             in case of conflict, infered data are kept and a warning message is displayed.
             If you are sure about your data, report a bug.
         </para>
         <para>Some examples are given below:</para>
-        <itemizedlist>
+          <itemizedlist>
+            <listitem>
+              <literal>%m2scideclare var1|2 3|Double|Real</literal>
+              <para>
+                var1 is declared as a 2x3 Double matrix containing real data.
+              </para>
+            </listitem>
+            <listitem>
+              <literal>%m2scideclare var2|2 3 10|Double|Complex</literal>
+              <para>
+                var2 is declared as a 2x3x10 Double hypermatrix containing complex data
+              </para>
+            </listitem>
+            <listitem>
+              <literal>%m2scideclare var3(1,2).name|1 10|String|?</literal>
+              <para>
+                var3 is declared as a Struct array containing a 1x10 character string
+                in field 'name' of struct at index (1,2)
+              </para>
+            </listitem>
+            <listitem>
+              <literal>%m2scideclare var4(1,5).entries|1 ?|Boolean|?</literal>
+              <para>
+                var4 is declared as a Cell containing a row boolean vector at index (1,5)
+              </para>
+            </listitem>
+            <listitem>
+              <literal>%m2scideclare var4(1,6).entries|? ?|Int|?</literal>
+              <para>
+                var4 is declared as a Cell containing a row boolean vector at index (1,5)
+                and integer data at index (1,6)
+              </para>
+            </listitem>
+            <listitem>
+              <literal>%m2scideclare var5(*,*).name|1 ?|String|?</literal>
+              <para>
+                var5 is declared as a Struct array containing a 1xn character string
+                in all fields 'name'
+              </para>
+            </listitem>
             <listitem>
-                <itemizedlist>
-                    <listitem>
-                        <para>
-                            <literal>%m2scideclare var1|2 3|Double|Real</literal>var1 is declared as a 2x3 Double matrix containing real data
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <literal>%m2scideclare var2|2 3 10|Double|Complex</literal>var2 is declared as a 2x3x10 Double hypermatrix containing complex data
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <literal>%m2scideclare var3(1,2).name|1 10|String|?</literal>var3 is declared as a Struct array containing a 1x10 character string
-                            in field 'name' of struct at index (1,2)
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <literal>%m2scideclare var4(1,5).entries|1 ?|Boolean|?</literal>var4 is declared as a Cell containing a row boolean vector at index (1,5)
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <literal>%m2scideclare var4(1,6).entries|? ?|Int|?</literal>var4 is declared as a Cell containing a row boolean vector at index (1,5)
-                            and integer data at index (1,6)
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <literal>%m2scideclare var5(*,*).name|1 ?|String|?</literal>var5 is declared as a Struct array containing a 1xn character string
-                            in all fields 'name'
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <literal>%m2scideclare var6(2,*).entries|1 3|Double|Real</literal>var6 is declared as a Cell array containing a 1x3 double vector
-                            in each element of its second row
-                        </para>
-                    </listitem>
-                </itemizedlist>
+              <literal>%m2scideclare var6(2,*).entries|1 3|Double|Real</literal>
+              <para>
+                var6 is declared as a Cell array containing a 1x3 double vector
+                in each element of its second row
+              </para>
             </listitem>
-        </itemizedlist>
+          </itemizedlist>
     </refsection>
 </refentry>
index 69ba987..66a0f82 100644 (file)
  * 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="fr" xml:id="m2scideclare">
+<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="fr" xml:id="m2scideclare">
     <refnamediv>
         <refname>m2scideclare</refname>
         <refpurpose>Donner des indices pour aider M2SCI...</refpurpose>
         <para>
             avec :
         </para>
-        <itemizedlist>
+          <itemizedlist>
             <listitem>
-                <itemizedlist>
-                    <listitem>
-                        <para>
-                            nom_de_variable : nom de la variable déclarée. Ce nom peut être
-                            un champ de Struct (e.g. <literal>x(1,2).nom</literal>)
-                            ou décrire le contenu d'une Cell en utilisant la syntaxe
-                            <literal>x(1,2).entries</literal>. NOTEZ que pour les Cells et les
-                            Structs <literal>*</literal> peut être utilisé comme index.
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            dimensions : dimensions de la variable déclarée séparées par des espaces,
-                            si une dimension est inconnue, remplacez la par <literal>?</literal>. NOTEZ que
-                            les dimensions des chaînes de caractère doivent être identiques aux dimensions
-                            Matlab e.g. <literal>1 6</literal> pour la chaîne de caractères 'chaine'.
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            type_de_données: le type de donnée de la variable qui peut être :
-                        </para>
-                        <informaltable border="1">
-                            <tr>
-                                <td>Type de donnée m2scideclare</td>
-                                <td>Type Scilab "équivalent"</td>
-                            </tr>
-                            <tr>
-                                <td>Double</td>
-                                <td>1</td>
-                            </tr>
-                            <tr>
-                                <td>Boolean</td>
-                                <td>4</td>
-                            </tr>
-                            <tr>
-                                <td>Sparse</td>
-                                <td>5</td>
-                            </tr>
-                            <tr>
-                                <td>Int</td>
-                                <td>8</td>
-                            </tr>
-                            <tr>
-                                <td>Handle</td>
-                                <td>9</td>
-                            </tr>
-                            <tr>
-                                <td>String</td>
-                                <td>10</td>
-                            </tr>
-                            <tr>
-                                <td>Struct</td>
-                                <td>Struct Matlab (16)</td>
-                            </tr>
-                            <tr>
-                                <td>Cell</td>
-                                <td>Cell Matlab (17)</td>
-                            </tr>
-                            <tr>
-                                <td>Void</td>
-                                <td>Sans type (0)</td>
-                            </tr>
-                            <tr>
-                                <td>?</td>
-                                <td>Type inconnu</td>
-                            </tr>
-                        </informaltable>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            propriété : propriété de la variable qui peut être :
-                        </para>
-                        <informaltable border="1">
-                            <tr>
-                                <td>Propriété m2scideclare</td>
-                                <td>"Equivalent" Scilab</td>
-                            </tr>
-                            <tr>
-                                <td>Real</td>
-                                <td>Donnée réelle</td>
-                            </tr>
-                            <tr>
-                                <td>Complex</td>
-                                <td>Donnée complexe</td>
-                            </tr>
-                            <tr>
-                                <td>?</td>
-                                <td>Property inconnue</td>
-                            </tr>
-                        </informaltable>
-                        <para>
-                            Ce champ est ignoré pour les types de données suivants : <literal>Cell</literal>,
-                            <literal>Struct</literal>, <literal>String</literal> et <literal>Boolean</literal>.
-                        </para>
-                    </listitem>
-                </itemizedlist>
+              <para>
+                nom_de_variable : nom de la variable déclarée. Ce nom peut être
+                un champ de Struct (e.g. <literal>x(1,2).nom</literal>)
+                ou décrire le contenu d'une Cell en utilisant la syntaxe
+                <literal>x(1,2).entries</literal>. NOTEZ que pour les Cells et les
+                Structs <literal>*</literal> peut être utilisé comme index.
+              </para>
             </listitem>
-        </itemizedlist>
+            <listitem>
+              <para>
+                dimensions : dimensions de la variable déclarée séparées par des espaces,
+                si une dimension est inconnue, remplacez la par <literal>?</literal>. NOTEZ que
+                les dimensions des chaînes de caractère doivent être identiques aux dimensions
+                Matlab e.g. <literal>1 6</literal> pour la chaîne de caractères 'chaine'.
+              </para>
+            </listitem>
+            <listitem>
+              <para>
+                type_de_données: le type de donnée de la variable qui peut être :
+              </para>
+              <informaltable border="1">
+                <tr>
+                  <td>Type de donnée m2scideclare</td>
+                  <td>Type Scilab "équivalent"</td>
+                </tr>
+                <tr>
+                  <td>Double</td>
+                  <td>1</td>
+                </tr>
+                <tr>
+                  <td>Boolean</td>
+                  <td>4</td>
+                </tr>
+                <tr>
+                  <td>Sparse</td>
+                  <td>5</td>
+                </tr>
+                <tr>
+                  <td>Int</td>
+                  <td>8</td>
+                </tr>
+                <tr>
+                  <td>Handle</td>
+                  <td>9</td>
+                </tr>
+                <tr>
+                  <td>String</td>
+                  <td>10</td>
+                </tr>
+                <tr>
+                  <td>Struct</td>
+                  <td>Struct Matlab (16)</td>
+                </tr>
+                <tr>
+                  <td>Cell</td>
+                  <td>Cell Matlab (17)</td>
+                </tr>
+                <tr>
+                  <td>Void</td>
+                  <td>Sans type (0)</td>
+                </tr>
+                <tr>
+                  <td>?</td>
+                  <td>Type inconnu</td>
+                </tr>
+              </informaltable>
+            </listitem>
+            <listitem>
+              <para>
+                propriété : propriété de la variable qui peut être :
+              </para>
+              <informaltable border="1">
+                <tr>
+                  <td>Propriété m2scideclare</td>
+                  <td>"Equivalent" Scilab</td>
+                </tr>
+                <tr>
+                  <td>Real</td>
+                  <td>Donnée réelle</td>
+                </tr>
+                <tr>
+                  <td>Complex</td>
+                  <td>Donnée complexe</td>
+                </tr>
+                <tr>
+                  <td>?</td>
+                  <td>Property inconnue</td>
+                </tr>
+              </informaltable>
+              <para>
+                Ce champ est ignoré pour les types de données suivants : <literal>Cell</literal>,
+                <literal>Struct</literal>, <literal>String</literal> et <literal>Boolean</literal>.
+              </para>
+            </listitem>
+          </itemizedlist>
         <para>
             Toutes les informations données par <literal>m2scideclare</literal> sont comparées avec
             les données inférées, en cas de conflit, les données inférées sont conservées et
             un warning est affiché. Si vous êtes sûrs de vos informations, rapportez ce bug.
         </para>
         <para>Voici quelques exemples :</para>
-        <itemizedlist>
-            <listitem>
-                <itemizedlist>
-                    <listitem>
-                        <para>
-                            <literal>%m2scideclare var1|2 3|Double|Real</literal>var1 est déclarée comme une matrice de Doubles de taille 2x3
-                            et contenant des données réelles
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <literal>%m2scideclare var2|2 3 10|Double|Complex</literal>var2 est déclarée comme une hypermatrice de Doubles de taille 2x3x10
-                            et contenant des données complexes
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <literal>%m2scideclare var3(1,2).name|1 10|String|?</literal>var3 est déclarée comme un tableau de Structs contenant une chaîne de
-                            caractères de taille 1x10 dans le champ 'name' de la Struct à l'indice (1,2)
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <literal>%m2scideclare var4(1,5).entries|1 ?|Boolean|?</literal>var4 est déclarée comme un tableau de Cells contenant
-                            un vecteur ligne de booléens à l'indice (1,5)
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <literal>%m2scideclare var4(1,6).entries|? ?|Int|?</literal>var4 est déclarée comme un tableau de Cells contenant
-                            un vecteur ligne de booléens à l'indice (1,5)
-                            et des données entières à l'indice (1,6)
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <literal>%m2scideclare var5(*,*).name|1 ?|String|?</literal>var5 est déclarée comme un tableau de Structs contenant une
-                            chaîne de caractères de taille 1xn dans chaque champ 'name'
-                        </para>
-                    </listitem>
-                    <listitem>
-                        <para>
-                            <literal>%m2scideclare var6(2,*).entries|1 3|Double|Real</literal>var6 est déclarée comme un tableau de Cells contenant un
-                            veteur de Doubles de taille 1x3 dans chaque élement de sa
-                            seconde ligne.
-                        </para>
-                    </listitem>
-                </itemizedlist>
-            </listitem>
-        </itemizedlist>
+           <itemizedlist>
+              <listitem>
+                <literal>%m2scideclare var1|2 3|Double|Real</literal>
+                <para>
+                  var1 est déclarée comme une matrice de Doubles de taille 2x3
+                  et contenant des données réelles
+                </para>
+              </listitem>
+              <listitem>
+                <literal>%m2scideclare var2|2 3 10|Double|Complex</literal>
+                <para>
+                  var2 est déclarée comme une hypermatrice de Doubles de taille 2x3x10
+                  et contenant des données complexes
+                </para>
+              </listitem>
+              <listitem>
+                <literal>%m2scideclare var3(1,2).name|1 10|String|?</literal>
+                <para>
+                  var3 est déclarée comme un tableau de Structs contenant une chaîne de
+                  caractères de taille 1x10 dans le champ 'name' de la Struct à l'indice (1,2)
+                </para>
+              </listitem>
+              <listitem>
+                <literal>%m2scideclare var4(1,5).entries|1 ?|Boolean|?</literal>
+                <para>
+                  var4 est déclarée comme un tableau de Cells contenant
+                  un vecteur ligne de booléens à l'indice (1,5)
+                </para>
+              </listitem>
+              <listitem>
+                <literal>%m2scideclare var4(1,6).entries|? ?|Int|?</literal>
+                <para>
+                  var4 est déclarée comme un tableau de Cells contenant
+                  un vecteur ligne de booléens à l'indice (1,5)
+                  et des données entières à l'indice (1,6)
+                </para>
+              </listitem>
+              <listitem>
+                <literal>%m2scideclare var5(*,*).name|1 ?|String|?</literal>
+                <para>
+                  var5 est déclarée comme un tableau de Structs contenant une
+                  chaîne de caractères de taille 1xn dans chaque champ 'name'
+                </para>
+              </listitem>
+              <listitem>
+                <literal>%m2scideclare var6(2,*).entries|1 3|Double|Real</literal>
+                <para>
+                  var6 est déclarée comme un tableau de Cells contenant un
+                  veteur de Doubles de taille 1x3 dans chaque élement de sa
+                  seconde ligne.
+                </para>
+              </listitem>
+          </itemizedlist>
     </refsection>
 </refentry>
index 45deba5..30101c1 100644 (file)
  * 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: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="tbx_builder_macros" xml:lang="en">
+<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="tbx_builder_macros" xml:lang="en">
     <refnamediv>
         <refname>tbx_builder_macros</refname>
         <refpurpose>Create library(es) of a toolbox for its functions in Scilab language</refpurpose>
@@ -46,8 +49,8 @@
     <refsection role="description">
         <title>Description</title>
         <para>
-            This function is usually called from <literal>builder.sce</literal> scripts when
-            creating or updating a toolbox.
+            This function is usually called by <literal>tbx_make(..)</literal> or called from
+            <literal>builder.sce</literal> scripts, when creating or updating a toolbox.
         </para>
         <warning>
           The short name (id) <literal>tbx_name</literal> of the toolbox is retrieved as the basename
@@ -77,7 +80,7 @@
               </itemizedlist>
               </listitem>
               <listitem>
-                 Otherwise, <function>tbx_builder_macros</function> exists silently.
+                 Otherwise, <function>tbx_builder_macros</function> exits silently.
               </listitem>
             </itemizedlist>
         </para>
@@ -95,6 +98,15 @@ tbx_builder_macros(get_absolute_file_path('builder.sce'))
  ]]></programlisting>
     </refsection>
 
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="tbx_make">tbx_make</link>
+            </member>
+        </simplelist>
+    </refsection>
+
     <refsection role="history">
         <title>History</title>
         <revhistory>
index e954ff7..e604a82 100644 (file)
@@ -10,5 +10,5 @@
 // For more information, see the COPYING file which you should have received
 // along with this program.
 
-add_help_chapter("Gestionnaire de modules externe", SCI+"/modules/modules_manager/help/fr_FR",%T);
+add_help_chapter("Créer un module externe", SCI+"/modules/modules_manager/help/fr_FR",%T);
 
index 6c12eba..b284de7 100644 (file)
  * 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: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="scinotes" xml:lang="en">
+<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="scinotes" xml:lang="en">
     <refnamediv>
         <refname>scinotes</refname>
         <refpurpose>Scinotes: Embedded Scilab text editor</refpurpose>
@@ -96,7 +99,9 @@
             they cannot be modified.
         </para>
 
-        <para>With the options 'indent', 'quote' or 'trailing', the editor will not be opened and the file(s) will be treated consequently to the actions. The actions are the following:
+        <para>
+          With the options 'indent', 'quote' or 'trailing', the editor will not be opened
+          and the file(s) will be treated consequently to the actions. The actions are the following:
             <itemizedlist>
                 <listitem>
                     <para>
             </listitem>
         </itemizedlist>
     </refsection>
-    <refsection>
+    <refsection id="scinotes_menus_shortcuts">
         <title>Menus and Shortcuts</title>
         <itemizedlist>
             <listitem>
@@ -559,22 +564,53 @@ scinotes(['SCI/modules/time/macros/datenum.sci','SCI/modules/time/macros/datevec
 
 
 f=TMPDIR + "/file_to_correct.sci";
-mputl(["a=''abcdef''                                                                   ";
+mputl(["a=''abcdef''                                    ";
        "if a==1";
        "   b=1+""abcdef''         ";
-       "                       c=2";
-       " d=3                   ";
-       "                                               if                                              ";
+       "            c=2";
+       " d=3            ";
+       "                            if                              ";
        "a=''abcdef""""""";
        "           end";
-       "                               end              "], f);
+       "                end              "], f);
 
 scinotes(f, ["indent" "trailing" "quote"]);
 
 // Show the results
-mgetl(f)
-
+write(%io(2), mgetl(f))
  ]]></programlisting>
+      <screen><![CDATA[
+--> write(%io(2),mgetl(f))
+a="abcdef"
+if a==1
+    b=1+"abcdef"
+    c=2
+    d=3
+    if
+        a="abcdef"""
+    end
+end
+]]></screen>
+    </refsection>
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="edit">edit</link>
+            </member>
+            <member>
+                <link linkend="editvar">editvar</link>
+            </member>
+            <member>
+                <link linkend="object_editor">ged</link>
+            </member>
+            <member>
+                <link linkend="ieditor">ieditor</link>
+            </member>
+            <member>
+                <link linkend="console">console</link>
+            </member>
+        </simplelist>
     </refsection>
     <refsection>
         <title>History</title>
@@ -585,5 +621,4 @@ mgetl(f)
             </revision>
         </revhistory>
     </refsection>
-
 </refentry>
index 2b43cb7..a57e211 100644 (file)
  * 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: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="scinotes" xml:lang="ja">
+<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="scinotes" xml:lang="ja">
     <refnamediv>
         <refname>scinotes</refname>
         <refpurpose>Scinotes: Scilab組込みテキストエディタ</refpurpose>
             </listitem>
         </itemizedlist>
     </refsection>
-    <refsection>
+    <refsection id="scinotes_menus_shortcuts">
         <title>メニューとショートカット</title>
         <itemizedlist>
             <listitem>
@@ -552,19 +555,51 @@ scinotes(['SCI/modules/time/macros/datenum.sci','SCI/modules/time/macros/datevec
         Scilabコードをインデント
         <programlisting role="example"><![CDATA[
 f=TMPDIR + "/file_to_correct.sci";
-mputl(["a=''abcdef''                                                                   ";
+mputl(["a=''abcdef''                                    ";
        "if a==1";
        "   b=1+""abcdef''         ";
-       "                       c=2";
-       " d=3                   ";
-       "                                               if                                              ";
+       "            c=2";
+       " d=3            ";
+       "                            if                              ";
        "a=''abcdef""""""";
        "           end";
-       "                               end              "], f);
+       "                end              "], f);
 scinotes(f, ["indent" "trailing" "quote"]);
 // 結果を表示
-mgetl(f)
+write(%io(2),mgetl(f))
  ]]></programlisting>
+      <screen><![CDATA[
+--> write(%io(2),mgetl(f))
+a="abcdef"
+if a==1
+    b=1+"abcdef"
+    c=2
+    d=3
+    if
+        a="abcdef"""
+    end
+end
+]]></screen>
+    </refsection>
+    <refsection role="see also">
+        <title>参照</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="edit">edit</link>
+            </member>
+            <member>
+                <link linkend="editvar">editvar</link>
+            </member>
+            <member>
+                <link linkend="object_editor">ged</link>
+            </member>
+            <member>
+                <link linkend="ieditor">ieditor</link>
+            </member>
+            <member>
+                <link linkend="console">console</link>
+            </member>
+        </simplelist>
     </refsection>
     <refsection>
         <title>履歴</title>
index 8f3414f..e6d14d9 100644 (file)
@@ -2,14 +2,17 @@
 <!--
  * 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="en_US" xml:id="convol2d">
+<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_US" xml:id="convol2d">
     <refnamediv>
         <refname>convol2d</refname>
         <refpurpose>discrete 2-D convolution, using fft. </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Syntax</title>
-        <synopsis>C = convol2d(A,B)</synopsis>
+        <synopsis>C = convol2d(A, B)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Parameters</title>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>convol2d</literal> uses fft to compute the full
-            two-dimensional discrete convolution. The
-            dimensions of the result<literal>C</literal> are given by
-            <literal>size(A)+size(B)+1</literal>. The indices of the
-            center element of <literal>B</literal> are defined as
-            <literal>floor((size(B)+1)/2)</literal>.
+            <literal>convol2d</literal> uses fft to compute the full two-dimensional discrete
+            convolution. The dimensions of the result <varname>C</varname> are given by
+            <literal>size(A)+size(B)-1</literal>. The indices of the center element of
+            <varname>B</varname> are defined as <literal>floor((size(B)+1)/2)</literal>.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[
-    s = [1 2 1; 0 0 0; -1 -2 -1];//Sobel horizontal edge kernel
-    A = zeros(10,10);A(3:7,3:7) = 1;
-    convol2d(s,A);
+s = [1 2 1; 0 0 0; -1 -2 -1] // Sobel horizontal edge kernel
+A = zeros(10,10); A(3:7,3:7) = 1
+C = convol2d(s, A);
+clean(C)
     ]]></programlisting>
+    <screen><![CDATA[
+--> s = [1 2 1; 0 0 0; -1 -2 -1] // Sobel horizontal edge kernel
+ s  =
+   1.   2.   1.
+   0.   0.   0.
+  -1.  -2.  -1.
+
+--> A = zeros(10,10); A(3:7,3:7) = 1
+ A  =
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.   1.   1.   1.   1.   1.   0.   0.   0.
+   0.   0.   1.   1.   1.   1.   1.   0.   0.   0.
+   0.   0.   1.   1.   1.   1.   1.   0.   0.   0.
+   0.   0.   1.   1.   1.   1.   1.   0.   0.   0.
+   0.   0.   1.   1.   1.   1.   1.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+
+--> C = convol2d(s, A);
+--> clean(C)
+ ans  =
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.   1.   3.   4.   4.   4.   3.   1.   0.   0.   0.
+   0.   0.   1.   3.   4.   4.   4.   3.   1.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.  -1.  -3.  -4.  -4.  -4.  -3.  -1.   0.   0.   0.
+   0.   0.  -1.  -3.  -4.  -4.  -4.  -3.  -1.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+]]></screen>
     </refsection>
     <refsection role="see also">
         <title>See also</title>
                 <link linkend="conv2">conv2</link>
             </member>
             <member>
+                <link linkend="conv">conv</link>
+            </member>
+            <member>
                 <link linkend="convol">convol</link>
             </member>
+            <member>
+                <link linkend="real">real</link>
+            </member>
+            <member>
+                <link linkend="clean">clean</link>
+            </member>
         </simplelist>
     </refsection>
     <refsection>
-        <title>Used Functions</title>
-        <para>
-            The  <literal>convol2d</literal> function is based on the <link linkend="fft">fft</link> builtin.
-        </para>
-    </refsection>
-    <refsection>
         <title>History</title>
         <revhistory>
             <revision>
index a5c2533..2be746e 100644 (file)
     </refnamediv>
     <refsynopsisdiv>
         <title>Syntax</title>
-        <synopsis>X=dct(A [,sign] [,option])
-            X=dct(A,sign,selection [,option])
-            X=dct(A,sign,dims,incr [,option])
-            X=idct(A [,option])
-            X=idct(A,selection [,option])
-            X=idct(A,dims,incr [,option])
+        <synopsis>
+            X = dct(A)
+            X = dct(A, sign)
+            X = dct(A, sign, selection)
+            X = dct(A, sign, dims, incr)
+            X = dct(.., option)
+
+            X = idct(A)
+            X = idct(A, selection)
+            X = idct(A, dims, incr)
+            X = idct(.., option)
         </synopsis>
     </refsynopsisdiv>
     <refsection>
   //----------------------------------
   // build a sampled at 1000hz  containing pure frequencies
   // at 50 and 70 Hz
-  sample_rate=1000;
+  sample_rate = 1000;
   t = 0:1/sample_rate:0.6;
-  N=size(t,'*'); //number of samples
-  s=sin(2*%pi*50*t)+sin(2*%pi*70*t+%pi/4)+grand(1,N,'nor',0,1);
-  d=dct(s);
+  N = size(t,'*'); //number of samples
+  s = sin(2*%pi*50*t) + sin(2*%pi*70*t+%pi/4) + grand(1,N,'nor',0,1);
+  d = dct(s);
   // zero low energy components
-  d(abs(d)<1)=0;
-  size(find(y1<>0),'*') //only 30 non zero coefficients out of 600
-  clf;plot(s,'b'),plot(dct(d,1),'r')
-
+  d(abs(d)<1) = 0;
+  size(find(d<>0), '*') //only 30 non zero coefficients out of 600
+  clf
+  plot(s,'b')
+  plot(dct(d,1),'r')
   ]]></programlisting>
 
         <para>2-D dct</para>
diff --git a/scilab/modules/signal_processing/help/fr_FR/howto/CHAPTER b/scilab/modules/signal_processing/help/fr_FR/howto/CHAPTER
deleted file mode 100644 (file)
index d44a1c7..0000000
+++ /dev/null
@@ -1 +0,0 @@
-title = How To
index 2876267..fa95756 100644 (file)
@@ -2,7 +2,10 @@
 <!--
  * 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_JP" xml:id="convol2d">
+<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_JP" xml:id="convol2d">
     <refnamediv>
         <refname>convol2d</refname>
         <refpurpose>離散 2-D 畳み込み, fftを使用. </refpurpose>
         <para>
             <literal>convol2d</literal> は
             完全な二次元離散畳み込みを計算するためにfftを使用します.
-            結果 <literal>C</literal> の次元は
-            <literal>size(A)+size(B)+1</literal>で指定されます.
-            <literal>B</literal>の中心要素の添字は
+            結果 <varname>C</varname> の次元は
+            <literal>size(A)+size(B)-1</literal>で指定されます.
+            <varname>B</varname>の中心要素の添字は
             <literal>floor((size(B)+1)/2)</literal>で定義されます.
         </para>
     </refsection>
     <refsection>
         <title>例</title>
         <programlisting role="example"><![CDATA[
-    s = [1 2 1; 0 0 0; -1 -2 -1];//Sobel horizontal edge kernel
-    A = zeros(10,10);A(3:7,3:7) = 1;
-    convol2d(s,A);
+s = [1 2 1; 0 0 0; -1 -2 -1] // Sobel horizontal edge kernel
+A = zeros(10,10); A(3:7,3:7) = 1
+C = convol2d(s, A);
+clean(C)
     ]]></programlisting>
+    <screen><![CDATA[
+--> s = [1 2 1; 0 0 0; -1 -2 -1] // Sobel horizontal edge kernel
+ s  =
+   1.   2.   1.
+   0.   0.   0.
+  -1.  -2.  -1.
+
+--> A = zeros(10,10); A(3:7,3:7) = 1
+ A  =
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.   1.   1.   1.   1.   1.   0.   0.   0.
+   0.   0.   1.   1.   1.   1.   1.   0.   0.   0.
+   0.   0.   1.   1.   1.   1.   1.   0.   0.   0.
+   0.   0.   1.   1.   1.   1.   1.   0.   0.   0.
+   0.   0.   1.   1.   1.   1.   1.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+
+--> C = convol2d(s, A);
+--> clean(C)
+ ans  =
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.   1.   3.   4.   4.   4.   3.   1.   0.   0.   0.
+   0.   0.   1.   3.   4.   4.   4.   3.   1.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.  -1.  -3.  -4.  -4.  -4.  -3.  -1.   0.   0.   0.
+   0.   0.  -1.  -3.  -4.  -4.  -4.  -3.  -1.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.   0.
+]]></screen>
     </refsection>
     <refsection role="see also">
         <title>参照</title>
@@