Help pages: misc. small improvements & fix 87/19987/18
Samuel GOUGEON [Mon, 30 Apr 2018 23:52:16 +0000 (01:52 +0200)]
 * polyline_properties: history section updated for 5.5.0
 * overloading: implicit polynom => implicit list. type_code 0 added.
 * type: simplifying the description of type 0 (some details were not
   really about type()).
 * clc: See also => + clf, host cls
 * system_get|setproperty: See also section added. minor fix/improv.
 * rcond() version was outdated for fr and pt
 * delip(): http://bugzilla.scilab.org/7582
   It's not possible to move the code => keeping track of the parent
   module in moved help pages.
 * whereis() is fixed:
      http://bugzilla.scilab.org/14752
      http://bugzilla.scilab.org/15542

Change-Id: Ic244f69677d53cef5952b0d58c230882f6b9d596

36 files changed:
scilab/modules/console/help/en_US/clc.xml
scilab/modules/console/help/fr_FR/clc.xml
scilab/modules/console/help/ja_JP/clc.xml
scilab/modules/console/help/ru_RU/clc.xml
scilab/modules/core/help/en_US/1_keywords/less.xml
scilab/modules/core/help/fr_FR/2_control_flow/end.xml
scilab/modules/core/help/fr_FR/2_control_flow/for.xml
scilab/modules/data_structures/help/en_US/type.xml
scilab/modules/data_structures/help/en_US/typeof.xml
scilab/modules/data_structures/help/fr_FR/type.xml
scilab/modules/data_structures/help/fr_FR/typeof.xml
scilab/modules/data_structures/help/ja_JP/type.xml
scilab/modules/data_structures/help/pt_BR/typeof.xml
scilab/modules/functions/help/en_US/overloading.xml
scilab/modules/functions/help/en_US/whereis.xml
scilab/modules/functions/help/ja_JP/overloading.xml
scilab/modules/functions/help/pt_BR/overloading.xml
scilab/modules/functions/help/ru_RU/overloading.xml
scilab/modules/graphics/help/en_US/polygon/polyline_properties.xml
scilab/modules/graphics/help/ja_JP/polygon/polyline_properties.xml
scilab/modules/gui/help/en_US/uicontrol.xml
scilab/modules/gui/help/ja_JP/uicontrol.xml
scilab/modules/jvm/help/en_US/system_getproperty.xml
scilab/modules/jvm/help/en_US/system_setproperty.xml
scilab/modules/jvm/help/ja_JP/system_getproperty.xml
scilab/modules/jvm/help/ja_JP/system_setproperty.xml
scilab/modules/linear_algebra/help/en_US/matrix/rcond.xml
scilab/modules/linear_algebra/help/fr_FR/matrix/rcond.xml
scilab/modules/linear_algebra/help/ja_JP/matrix/rcond.xml
scilab/modules/linear_algebra/help/pt_BR/matrix/rcond.xml
scilab/modules/special_functions/help/en_US/delip.xml
scilab/modules/special_functions/help/fr_FR/delip.xml
scilab/modules/special_functions/help/ja_JP/delip.xml
scilab/modules/special_functions/help/pt_BR/delip.xml
scilab/modules/special_functions/help/ru_RU/delip.xml
scilab/modules/string/help/en_US/prettyprint.xml

index 20f2b66..212f14a 100644 (file)
@@ -65,6 +65,12 @@ clc(5); // Delete the 5 previous lines
             <member>
                 <link linkend="tohome">tohome</link>
             </member>
+            <member>
+                <link linkend="clf">clf</link>
+            </member>
+            <member>
+                <link linkend="consolebox">host cls (consolebox)</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
index e3fb64e..54ad64c 100644 (file)
@@ -65,6 +65,12 @@ clc(5); // Efface les 5 précédentes lignes.
             <member>
                 <link linkend="tohome">tohome</link>
             </member>
+            <member>
+                <link linkend="clf">clf</link>
+            </member>
+            <member>
+                <link linkend="consolebox">host cls (consolebox)</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
index efdeeda..eaf8860 100644 (file)
@@ -70,6 +70,12 @@ clc(5); // Delete the 5 previous lines
             <member>
                 <link linkend="tohome">tohome</link>
             </member>
+            <member>
+                <link linkend="clf">clf</link>
+            </member>
+            <member>
+                <link linkend="consolebox">host cls (consolebox)</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
index a3d77d4..942c9b8 100644 (file)
@@ -73,6 +73,12 @@ clc(5); // удаляет 5 предыдущих строчек
             <member>
                 <link linkend="tohome">tohome</link>
             </member>
+            <member>
+                <link linkend="clf">clf</link>
+            </member>
+            <member>
+                <link linkend="consolebox">host cls (consolebox)</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
index cbe09ef..776f2eb 100644 (file)
@@ -77,8 +77,8 @@
             <revision>
                 <revnumber>6.0</revnumber>
                 <revdescription>
-                    <literal>~</literal> (not) priority is now higher than <literal>&lt;</literal>,
-                    <literal>&lt;=</literal>, <literal>></literal> and <literal>>=</literal>one.
+                    <literal>~</literal> (not)'s priority is now higher than <literal>&lt;</literal>,
+                    <literal>&lt;=</literal>, <literal>></literal> and <literal>>=</literal> one.
                     For instance, <literal>~3&lt;1</literal> is parsed as <literal>(~3)&lt;1</literal>
                     instead of <literal>~(3&lt;1)</literal> and now yields an error instead of
                     <literal>%T</literal>.
index 63bf9fd..9a39b78 100644 (file)
         xml:lang="fr" xml:id="end">
     <refnamediv>
         <refname>end</refname>
-        <refpurpose>mot-clé end  </refpurpose>
+      <refpurpose>
+        Fin d'un bloc <literal>if</literal> ou <literal>select</literal>,
+        ou d'une boucle <literal>for</literal> ou <literal>while</literal>
+      </refpurpose>
     </refnamediv>
     <refsection>
         <title>Description</title>
@@ -99,8 +102,8 @@ end
                         </listitem>
                         <listitem>
                             <literal>end</literal> peut désormais être utilisé pour conclure un bloc
-                            <literal>function</literal>, à la place <literal>endfunction</literal>
-                            (lequel reste preferable).
+                            <literal>function</literal>, à la place de <literal>endfunction</literal>
+                            (lequel reste préférable).
                         </listitem>
                         <listitem>
                             <literal>end</literal> est désormais protégé. Les affectations telles que
index 883a77c..ae8f264 100644 (file)
@@ -20,7 +20,7 @@
         xml:lang="fr" xml:id="for">
     <refnamediv>
         <refname>for</refname>
-        <refpurpose>Mot-clé ouvrant une boucle itérative non conditionnelle</refpurpose>
+        <refpurpose>Ouverture d'une boucle itérative non conditionnelle</refpurpose>
     </refnamediv>
     <refsection>
         <title>Description</title>
index 6aebb33..5e99287 100644 (file)
             <varlistentry>
                 <term>0</term>
                 <listitem>
-                    An undefined component of a simple list. Such a component may be met as
-                    an omitted input argument when calling Scilab function like in
-                    <literal>foo(a,,b)</literal>: From within the function, the missing
-                    argument is defined but is of null type. Defining
-                    <literal>L=list(%pi,,%i,,,%z)</literal> creates L(2) of type 0; etc.
-                    For these objects, <code>isdef()</code> returns <literal>%T</literal>,
-                    but their null type can be tested with <literal>type()</literal>
+                    An undefined element of a list (with a typeof <literal>void</literal>, such as
+                    in the function call <literal>foo(a,,b)</literal>, or in
+                    <literal>list(%pi,,%i,,,%z)</literal>), or a null object of typeof
+                    <literal>listdelete</literal> returned by <literal>null()</literal>.
                 </listitem>
             </varlistentry>
         </variablelist>
@@ -297,6 +294,9 @@ type(r)                     // rational fractions
             <member>
                 <link linkend="mlist">mlist</link>
             </member>
+            <member>
+                <link linkend="null">null</link>
+            </member>
         </simplelist>
     </refsection>
     <refsection role="history">
@@ -312,9 +312,6 @@ type(r)                     // rational fractions
                     <member>
                        <literal>type(:)</literal> now returns 129 instead of 1.
                     </member>
-                    <member>
-                       Assigning an object of type 0 to a variable no longer deletes this one.
-                    </member>
                 </simplelist>
                 </revdescription>
             </revision>
index 04a6604..5edc404 100644 (file)
                 </td>
             </tr>
             <tr>
-                <td>
+                <td style="white-space:nowrap">
                     <emphasis role="bold">"Matlab sparse"</emphasis>
                 </td>
                 <td>
index a090d2a..270d4cc 100644 (file)
             <varlistentry>
                 <term>0</term>
                 <listitem>
-                    Elément d'une liste simple non défini. Il peut par exemple s'agir d'un
-                    argument d'entrée omis lors de l'appel d'une fonction Scilab tel que
-                    <literal>foo(a,,b)</literal> ; ou omis lors de la création d'une liste à
-                    trous telle que <literal>list(%pi,,%i,,,%z)</literal>, etc. Pour tester
-                    l'état de ces objets, <code>isdef()</code> répond <literal>%T</literal>,
-                    mais on pourra vérifier que leur type est nul.
+                    Elément non défini d'une liste (de typeof <literal>void</literal>, tel que
+                    dans l'appel de fonction <literal>foo(a,,b)</literal>, ou dans
+                    <literal>list(%pi,,%i,,,%z)</literal>),
+                    ou objet nul produit par <literal>null()</literal> (de typeof
+                    <literal>listdelete</literal>).
                 </listitem>
             </varlistentry>
         </variablelist>
@@ -300,6 +299,9 @@ type(r)                     // Fractions polynomiales (rationnelles)
             <member>
                 <link linkend="mlist">mlist</link>
             </member>
+            <member>
+                <link linkend="null">null</link>
+            </member>
         </simplelist>
     </refsection>
     <refsection role="history">
@@ -316,11 +318,7 @@ type(r)                     // Fractions polynomiales (rationnelles)
                         <member>
                            <literal>type(:)</literal> vaut désormais 129 au lieu de 1.
                         </member>
-                        <member>
-                            L'affectation d'un objet de type 0 à une variable ne détruit plus celle-ci.
-                        </member>
                     </simplelist>
-
                 </revdescription>
             </revision>
         </revhistory>
index 8f96ecf..50bad5b 100644 (file)
                 </td>
             </tr>
             <tr>
-                <td>
+                <td style="white-space:nowrap">
                     <emphasis role="bold">"Matlab sparse"</emphasis>
                 </td>
                 <td>
index 07f257e..dc9ae0b 100644 (file)
             : Scilab 内部コード (C または Fortran コード).
         </para>
         <para>0 :
-            An undefined component of a simple list. Such a component may be met as
-            an omitted input argument when calling Scilab function like in
-            <literal>foo(a,,b)</literal>: From within the function, the missing
-            argument is defined but is of null type. Defining
-            <literal>L=list(%pi,,%i,,,%z)</literal> creates L(2) of type 0; etc.
-            For these objects, <code>isdef()</code> returns <literal>%T</literal>,
-            but their null type can be tested with <literal>type()</literal>
+          An undefined element of a list (with a typeof <literal>void</literal>, such as
+          in the function call <literal>foo(a,,b)</literal>, or in
+          <literal>list(%pi,,%i,,,%z)</literal>), or a null object of typeof
+          <literal>listdelete</literal> returned by <literal>null()</literal>.
         </para>
         <refsect2>
             <title>Remarks</title>
@@ -256,6 +253,9 @@ type(r)                     // rational fractions
             <member>
                 <link linkend="mlist">mlist</link>
             </member>
+            <member>
+                <link linkend="null">null</link>
+            </member>
         </simplelist>
     </refsection>
     <refsection role="history">
@@ -271,9 +271,6 @@ type(r)                     // rational fractions
                     <member>
                        <literal>type(:)</literal> now returns 129 instead of 1.
                     </member>
-                    <member>
-                       Assigning an object of type 0 to a variable no longer deletes this one.
-                    </member>
                 </simplelist>
                 </revdescription>
             </revision>
index 8f0918f..6c182a3 100644 (file)
                 </td>
             </tr>
             <tr>
-                <td>
+                <td style="white-space:nowrap">
                     <emphasis role="bold">"Matlab sparse"</emphasis>
                 </td>
                 <td>
index eb4754c..a267111 100644 (file)
                 <td/>
             </tr>
             <tr>
-                <td>implicit polynom</td>
+                <td>implicit list</td>
                 <td>
                     <literal>ip</literal>
                 </td>
                 <td>
-                    <literal>size implicit</literal>
+                    <literal>implicitlist</literal>
                 </td>
                 <td>1:1:$</td>
             </tr>
+            <tr>
+                <td>undefined|null object</td>
+                <td>
+                    <literal>0</literal>
+                </td>
+                <td>
+                    <literal>listdelete, void</literal>
+                </td>
+                <td>see null(), list()</td>
+            </tr>
         </informaltable>
         <para>
             <literal>&lt;op_code&gt;</literal> is a single character associated
index bb1bfdf..989b8d5 100644 (file)
                     <term>a builtin written and compiled in an external language (C, C++..):</term>
                     <para>
                         <literal>whereis</literal> returns the name of the module the function
-                        belongs to. More precisely, the name of the "gateway" is returned.
-                        It matches the module's name for all cases except for
-                        <literal>action_binding_gw, functions_gw, matio_gw, signal_processing_gw,
-                        statistics_gw</literal>, for which <literal>"_gw"</literal>
-                        is appended to the module name.
+                        belongs to.
                     </para>
                     <para>
-                        The gateway file is located at
+                        The gateway file where the builtin function is declared to belong to the
+                        module is located at
                         <literal>SCI/modules/moduleName/gateway/moduleName_gateway.xml</literal>,
                         where <literal>moduleName</literal> must be replaced with the actual module name.
                     </para>
         <programlisting role="example"><![CDATA[
 // Case of an unregistered macro:
 function myTest(), disp("Unregistered function"), endfunction
-whereis("myTest")               // => "script"
+whereis myTest                  // => "script"
 
 // Case of a registered macro:
 r = whereis("ls")               // => "fileiolib"
@@ -181,7 +178,7 @@ whereis ls                      // => ["fileiolib"; "lslib"]
 
 // Case of a builtin function
 whereis sin                     // => "elementary_functions"
-whereis conv2                   // => "signal_processing_gw"
+whereis conv2                   // => "signal_processing"
 
 // Case of an unregistered macro defined/loaded after a registered one:
 clear ls lslib
index 085de83..fc9a2e9 100644 (file)
                 <td/>
             </tr>
             <tr>
-                <td>暗黙の多項式</td>
+                <td>暗黙のリスト</td>
                 <td>
                     <literal>ip</literal>
                 </td>
                 <td>
-                    <literal>size implicit</literal>
+                    <literal>implicitlist</literal>
                 </td>
                 <td>1:1:$</td>
             </tr>
+            <tr>
+                <td>undefined|null object</td>
+                <td>
+                    <literal>0</literal>
+                </td>
+                <td>
+                    <literal>listdelete, void</literal>
+                </td>
+                <td>see null(), list()</td>
+            </tr>
         </informaltable>
         <para>
             <literal>&lt;op_code&gt;</literal> は, 以下のテーブルに記述された
index ee67ce3..ae25e68 100644 (file)
                 </td>
             </tr>
             <tr>
-                <td>polinômio de tamanho implícito</td>
+                <td>lista implícita</td>
                 <td>
                     <literal>ip</literal>
                 </td>
index a84be30..30db924 100644 (file)
                 <td/>
             </tr>
             <tr>
-                <td>неявный полином</td>
+                <td>неявный список</td>
                 <td>
                     <literal>ip</literal>
                 </td>
                 <td>
-                    <literal>size implicit</literal>
+                    <literal>implicitlist</literal>
                 </td>
                 <td>1:1:$</td>
+            <tr>
+                <td>undefined|null object</td>
+                <td>
+                    <literal>0</literal>
+                </td>
+                <td>
+                    <literal>listdelete, void</literal>
+                </td>
+                <td>see null(), list()</td>
+            </tr>
             </tr>
         </informaltable>
         <para>
index e082bb6..260b399 100644 (file)
@@ -569,7 +569,26 @@ f.children.y_label.font_size = 3;
                 <revnumber>5.4.0</revnumber>
                 <revremark>
                   line_style value 0 is obsolete, use 1 instead (both are equivalent for  SOLID).
-                  Using value 0 will produce an error in Scilab 5.4.1.</revremark>
+                  Using value 0 will produce an error in Scilab 5.4.1.
+                </revremark>
+            </revision>
+            <revision>
+                <revnumber>5.5.0</revnumber>
+                <revremark>
+                <itemizedlist>
+                    <listitem>
+                        <literal>.mark_stride</literal> and <literal>.mark_offset</literal>
+                        properties added.
+                    </listitem>
+                    <listitem>
+                        <literal>.datatips</literal> property added.
+                    </listitem>
+                    <listitem>
+                        <literal>.display_function</literal> and
+                        <literal>.display_function_data</literal> properties added.
+                    </listitem>
+                </itemizedlist>
+                </revremark>
             </revision>
             <revision>
                 <revnumber>6.0.0</revnumber>
index 113cd0e..3329351 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 - Djalel Abdemouche
-
  *
-
-
  * Copyright (C) 2012 - 2016 - Scilab Enterprises
  *
  * This file is hereby licensed under the terms of the GNU GPL v2.0,
  * and continues to be available under such terms.
  * For more information, see the COPYING file which you should have received
  * along with this program.
-
  *
-
  -->
-
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
           xml:lang="ja" xml:id="polyline_properties">
-
     <refnamediv>
-
         <refname>polyline_properties</refname>
-
         <refpurpose>Polylineエンティティプロパティの説明
-
         </refpurpose>
-
     </refnamediv>
-
     <refsection>
-
         <title>説明</title>
-
         <para>Polylineエンティティはグラフィックエンティティ階層の葉です. このエンティティは
-
             ポリラインのパラメータを定義します.
-
         </para>
-
         <variablelist>
-
             <varlistentry>
-
                 <term>parent: </term>
-
                 <listitem>
-
                     <para>このフィールドには親のハンドルが含まれます.
-
                         polylineエンティティの親は<literal>"Axes"</literal> 型または
-
                         <literal>"Compound"</literal>型です.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>children: </term>
-
                 <listitem>
-
                     <para>
-
                         このプロパティにはこのハンドルの<literal>children</literal>
-
                         のベクトルが含まれます.
-
                         しかし,現在,polylineには<literal>children</literal>がありません.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>visible: </term>
-
                 <listitem>
-
                     <para>
-
                         このフィールドはこのエンティティの<literal>visible</literal>
-
                         プロパティの値を有します.
-
                         値は<literal>"on" </literal> または <literal>"off"</literal>となります.
-
                         デフォルトで polyline は可視であり,プロパティの値は
-
                         <literal>"on" </literal>となります. <literal>"off"</literal> の場合,
-
                         このポリラインは画面に描画されません.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>data: </term>
-
                 <listitem>
-
                     <para>このフィールドはxおよびy座標の値を有します.
-
                         3次元軸の場合にはZ要素が追加されます.
-
                         この値は,各点の座標を含む2(3)列の行列<literal>[x,y,[z]]</literal>です.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>closed: </term>
-
                 <listitem>
-
                     <para>このフィールドはポリラインが閉じているかどうかを定義します:
-
                         値は <literal>"on"</literal> または <literal>"off"</literal>となります
-
                         (デフォルト値はなく,ポリラインを作成する際に使用されたプリミティブに
-
                         依存します).
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>line_mode: </term>
-
                 <listitem>
-
                     <para>
-
                         このフィールドはポリラインの<literal>line_mode</literal>プロパティの
-
                         デフォルト値を有します. この値には <literal>"on" </literal>(線を描画
-
                         ) または <literal>"off"</literal> (線を描画しない)を指定します.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>fill_mode: </term>
-
                 <listitem>
-
                     <para>
-
                         <literal>polyline_style</literal>フィールドが  5ではない場合, 曲線の
-
                         背景が<literal>background</literal> プロパティで定義した色で塗られます.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>line_style: </term>
-
                 <listitem>
-
                     <para>
-
                         このフィールドは,Segs, Arcs, Rectangle および Polylineオブジェクトの
-
                         <literal>line_style</literal>のデフォルト値を有します.
-
                         <literal>line_style</literal>は,線を描画する際に使用される
-
                         線の型を選択します.この値は, [1 10]の範囲の整数となります.
-
                         1 は実線を意味し, 他の値は破線
-
                         (破線, 一点鎖線, 長一点鎖線, 大鎖線, 大長一点鎖線, 点線, 2重点線, 長空白点線, 大空白点線)
-
                         の選択を意味します. 以下の例を参照ください.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>thickness: </term>
-
                 <listitem>
-
                     <para>このプロパティはピクセル単位で線幅を指定する正の実数です.
-
                         実際の表示幅は指定された幅を最も近い整数に丸めることで定義されます.
-
                         唯一の例外はベクトル単位のエキスポートで,この場合は全体の
-
                         <literal>thickness</literal>の値が考慮されます.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>arrow_size_factor: </term>
-
                 <listitem>
-
                     <para>この整数によりポリラインに描かれる矢印の大きさを設定することができます.
-
                         実際の矢印の大きさは<literal>thickness</literal>とこのsize factorの
-
                         積となります.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>polyline_style: </term>
-
                 <listitem>
-
                     <para>このプロパティは以下の各種のポリライン描画モードを設定します:</para>
-
                     <itemizedlist>
-
                         <listitem>
-
                             <para>値が 0または1の場合,連続する2つの点の間に線が描画されます.</para>
-
                         </listitem>
-
                         <listitem>
-
                             <para>値が2の場合,ポリラインは階段プロットとなります.
-
                                 連続する2つの点は水平線の後に垂直線が続く線により結合されます.
-
                             </para>
-
                         </listitem>
-
                         <listitem>
-
                             <para>値が3の場合,ポリラインは棒グラフとなります.
-
                                 指定された各(x,y)について, (x,y) から
-
                                 (x,0)に垂直線が引かれます.
-
                             </para>
-
                         </listitem>
-
                         <listitem>
-
                             <para>値が 4の場合,連続する2つの点の間に矢印が描かれます.</para>
-
                         </listitem>
-
                         <listitem>
-
                             <para>値が5の場合,ポリラインは塗りつぶされます (パッチ).</para>
-
                         </listitem>
-
                         <listitem>
-
                             <para>値が 6の場合,ポリラインはMatlabに似たbarオブジェクトとなります.
-
                                 プロパティ<literal>bar_shift</literal> および<literal>bar_width</literal>
-
                                 がその外観を規定します.
-
                             </para>
-
                         </listitem>
-
                     </itemizedlist>
-
                     <para>
-
                         <inlinemediaobject>
-
                             <imageobject>
-
                                 <imagedata fileref="../../images/polyline_style.svg"/>
-
                             </imageobject>
-
                         </inlinemediaobject>
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>foreground: </term>
-
                 <listitem>
-
                     <para>このフィールドにはポリラインを描画する際に使用される
-
                         <literal>foreground</literal>プロパティのデフォルト値が含まれます.
-
                         その値には(カレントのカラーマップに沿った)色インデックスを指定します.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>background: </term>
-
                 <listitem>
-
                     <para>このフィールドはポリラインの背景を塗りつぶす際に使用される色を有します.
-
                         その値には(カレントのカラーマップに沿った)色インデックスを指定します.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>interp_color_vector: </term>
-
                 <listitem>
-
                     <para>このフィールドは,
-
                         <literal>interp_color_mode</literal>プロパティが<literal>"on"</literal>に設定された
-
                         際にポリラインを塗る際に使用される色インデックスの
-
                         ベクトルを有します.
-
                         これは,各セグメントを塗る際に使用される
-
                         カラーマップインデックスの間隔を定義します.
-
                         例えば,最初のセグメントは,
-
                         インデックスがベクトルの最初の2つの要素の間にある各色により塗りつぶされます.
-
                         これはポリラインが 3 または 4つの点で定義されている場合のみ適用可能です.
-
                         このため,ベクトルの大きさはこの次元に一致している必要があります.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>interp_color_mode: </term>
-
                 <listitem>
-
                     <para>このフィールドはポリラインを塗る際に補間影モードを
-
                         使用するかどうかを定義します:
-
                         この値は<literal>"on"</literal> または<literal>"off"</literal>となります.
-
                         "on"に値を切り替える前に <literal>interp_color_vector</literal>を
-
                         定義する必要があります (上記参照).
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>mark_mode: </term>
-
                 <listitem>
-
                     <para>
-
                         このフィールドはポリラインの<literal>mark_mode</literal>
-
                         プロパティのデフォルト値を有します.
-
                         この値は<literal>"on"</literal> (マーカを描画
-
                         drawn) または <literal>"off"</literal> (マーカを描画しない)となります.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>mark_style: </term>
-
                 <listitem>
-
                     <para>
-
                         <literal>mark_style</literal>プロパティの値は
-
                         <literal>mark_mode</literal>プロパティが<literal>"on"</literal>の場合に,
-
                         使用するマーカの種類を選択するために使用されます.
-
                         この値は[0 14]の範囲の整数で,それぞれ以下の意味があります :
-
                         ドット,プラス,十字,星,塗りつぶした菱形,
-
                         上向き三角形, 下向き三角形, 菱形プラス,円,アスタリスク,
-
                         正方形,右向き三角形,左向き三角形およびペンタグラム.
-
                         以下の図は,マーカのアスペクトが<literal>mark_style</literal>,
-
                         <literal>mark_foreground</literal> および
-
                         <literal>mark_background</literal>プロパティに依存する
-
                         ことを示します.
-
                     </para>
-
                     <para>
-
                         <inlinemediaobject>
-
                             <imageobject>
-
                                 <imagedata fileref="../../images/marks.svg"/>
-
                             </imageobject>
-
                         </inlinemediaobject>
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>mark_size_unit: </term>
-
                 <listitem>
-
                     <para>
-
                         このフィールは<literal>mark_size_unit</literal>プロパティのデフォルト値
-
                         を有します.<literal>mark_size_unit</literal>が<literal>"point"</literal>
-
                         に設定された場合,<literal>mark_size</literal>の値はポイント単位で直接
-
                         指定されます.
-
                         <literal>mark_size_unit</literal> に<literal>"tabulated"</literal>が
-
                         指定された場合,<literal>mark_size</literal>はfont size配列に相対的に
-
                         計算されます: この場合,この値は,
-
                         8pt, 10pt, 12pt, 14pt, 18pt および 24pt を意味する
-
                         [0 5]の範囲の整数とします.
-
                         <link linkend="xrect">xrect</link>および Scilabのネーティブ関数は
-
                         <literal>tabulated</literal>モードをデフォルトとします;
-
                         <link linkend="plot">plot</link>関数を使用する場合,
-
                         <literal>point</literal> モードが自動的に有効となります.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>mark_size: </term>
-
                 <listitem>
-
                     <para>
-
                         <literal>mark_size</literal>プロパティは,
-
                         <literal>mark_mode</literal>プロパティが<literal>"on"</literal>の時,
-
                         マーカの大きさを選択するために使用されます.
-
                         この値は, 8pt, 10pt, 12pt, 14pt, 18pt および 24pt を意味する
-
                         [0 5]の範囲の整数です.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>mark_foreground: </term>
-
                 <listitem>
-
                     <para>
-
                         このフィールドは,マーカの縁の色である<literal>mark_foreground</literal>
-
                         プロパティの値を有します.この値は(カレントのcolor_mapに関連する)色インデックス
-
                         または透過エッジを意味する 0 とします.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>mark_background: </term>
-
                 <listitem>
-
                     <para>このフィールドは,マーカの前景色である
-
                         <literal>mark_background</literal>プロパティの値を有します.
-
                         この値は(カレントのcolor_mapに関連する)色インデックス
-
                         または透過エッジを意味する 0 とします.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>mark_offset: </term>
-
                 <listitem>
-
                     <para>
-
                         このフィールドは,
-
                         最初の記号を描画する際に使用されるオフセットである
-
                         <literal>mark_offset</literal> プロパティの値を有します.
-
                         この値は, 0 以上の整数とする必要があります (デフォルト値は 0).
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>mark_stride: </term>
-
                 <listitem>
-
                     <para>
-
                         このフィールドは,
-
                         記号を描画する際に使用するストライド
-
                         (すなわち, 2つの連続する記号の間で stride-1 個の点がスキップされます)
-
                         である <literal>mark_stride</literal> プロパティの値を有します.
-
                         この値は, 1以上の整数とする必要があります (デフォルト値は 1).
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>x_shift: </term>
-
                 <listitem>
-
                     <para>
-
                         このフィールドは関数<link linkend="bar">bar</link>をコールする
-
                         ことにより計算される
-
                         (または<link linkend="barhomogenize">barhomogenize</link>を
-
                         コールすることにより再計算される)オフセットを有し,
-
                         見栄えの良い垂直棒グラフを作成するために使用されます.
-
                         このオフセットは他の<literal>polyline_style</literal>にも
-
                         適用されることに注意してください.
-
                         単位はユーザ座標で表されます.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>y_shift: </term>
-
                 <listitem>
-
                     <para>
-
                         このフィールドは関数<link linkend="bar">bar</link>をコールする
-
                         ことにより計算される
-
                         (または<link linkend="barhomogenize">barhomogenize</link>を
-
                         コールすることにより再計算される)オフセットを有し,
-
                         見栄えの良い水平棒グラフを作成するために使用されます.
-
                         このオフセットは他の<literal>polyline_style</literal>にも
-
                         適用されることに注意してください.
-
                         単位はユーザ座標で表されます.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>z_shift: </term>
-
                 <listitem>
-
                     <para>このフィールドはユーザが指定する
-
                         オフセットを有します
-
                         このオフセットは他の<literal>polyline_style</literal>にも
-
                         適用されることに注意してください.
-
                         このユニットはユーザ座標で表されています.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>bar_width: </term>
-
                 <listitem>
-
                     <para>このフィールドは,
-
                         <literal>polyline_style</literal> が棒グラフモード (ケース 6)に
-
                         せていされている場合に,
-
                         選択されたポリラインの幅を定義します:
-
                         単位はユーザ座標で表されます.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>clip_state: </term>
-
                 <listitem>
-
                     <para>
-
                         このフィールドはポリラインの<literal>clip_state</literal>プロパティの
-
                         値を有します. 値は以下となります:
-
                     </para>
-
                     <itemizedlist>
-
                         <listitem>
-
                             <para>
-
                                 <literal>"off"</literal> ポリラインはクリップされません.
-
                             </para>
-
                         </listitem>
-
                         <listitem>
-
                             <para>
-
                                 <literal>"clipgrf"</literal> ポリラインはAxesボックスの外側でクリップ
-
                                 されます.
-
                             </para>
-
                         </listitem>
-
                         <listitem>
-
                             <para>
-
                                 <literal>"on"</literal>ポリラインはclip_boxプロパティで
-
                                 指定された矩形の外側でクリップされます.
-
                             </para>
-
                         </listitem>
-
                     </itemizedlist>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>clip_box: </term>
-
                 <listitem>
-
                     <para>
-
                         このフィールドは<literal>clip_box</literal>プロパティを定義します.
-
                         clip_state が "off" の場合, デフォルトで,この値は空の行列です.
-
                         その他の場合, ベクトル <literal>[x,y,w,h]</literal> (左上の点 幅 高さ)
-
                         は表示するポリラインの部分を定義しますが,
-
                         <literal>clip_state</literal>プロパティの値が変更されます.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>user_data: </term>
-
                 <listitem>
-
                     <para>このフィールドはpolylineデータ構造体に任意のScilab変数を
-
                         保存し,再度取得する際に使用できます.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>datatips: </term>
-
                 <listitem>
-
                     <para>
-
                         このプロパティは,ポリラインに関係する<literal>datatips</literal>のハンドルの
-
                         ベクトルを有します.
-
                         しかし, ポリラインのハンドルは現在<literal>children</literal>を有しません.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
                 <term>datatip_display_mode: </term>
                 <listitem>
                 </listitem>
             </varlistentry>
           <varlistentry>
-
                 <term>display_function: </term>
-
                 <listitem>
-
                     <para>
-
                         関数名を有する文字列. この関数の呼び出し手順は,
-
                         <literal>str=fun(datatipHandle)</literal> とします.
-
                         ただし,  <literal>datatipHandle</literal> は表示するdatatipの
-
                         ハンドルです.
-
                         この関数は, 文字列または文字列ベクトルを str に返します.
-
                     </para>
-
                     <para>
-
                         この関数は, datatip本体に類似のプロパティを設定することで,
-
                         オーバーロードできます.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>display_function_data: </term>
-
                 <listitem>
-
                     <para>
-
                         <literal>display_function</literal>関数で必要とされる全Scilabデータ.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
         </variablelist>
-
     </refsection>
-
     <refsection>
-
         <title>例</title>
-
         <programlisting role="example"><![CDATA[
-
 a=get("current_axes")//新規に作成された軸のハンドルを取得
-
 a.data_bounds=[-2,-2;2,2];
 
-
-
 xpoly(sin(2*%pi*(0:5)/5),cos(2*%pi*(0:5)/5),"lines",0)
-
 p=get("hdl"); //カレントのエンティティ(ここではpolylineエンティティ)のハンドルを取得
-
 p.foreground=2;
-
 p.thickness=3;
-
 p.mark_style=9;
-
 d=p.data;d(1,:)=[0 0];p.data=d;
-
 a.rotation_angles=[0 45];
-
  ]]></programlisting>
-
         <scilab:image>
-
             a=get("current_axes")
-
             a.data_bounds=[-2,-2;2,2];
-
             xpoly(sin(2*%pi*(0:5)/5),cos(2*%pi*(0:5)/5),"lines",0)
-
             p=get("hdl");
-
             p.foreground=2;
-
             p.thickness=3;
-
             p.mark_style=9;
-
             d=p.data;d(1,:)=[0 0];p.data=d;
-
             a.rotation_angles=[0 45];
-
         </scilab:image>
-
-
         <programlisting role="example"><![CDATA[
-
 xpoly(sin(2*%pi*(0:5)/5),cos(2*%pi*(0:5)/5),"lines",0)
-
 p=get("hdl"); //get handle on current entity (here the polyline entity)
-
 p.data=[(-2:0.1:2)' sin((-2:0.1:2)*%pi)']
-
 p.mark_mode="off";
-
 p.polyline_style=3;
-
 p.line_style=4;
-
  ]]></programlisting>
-
         <scilab:image>
-
             xpoly(sin(2*%pi*(0:5)/5),cos(2*%pi*(0:5)/5),"lines",0)
-
             p=get("hdl");
-
             p.data=[(-2:0.1:2)' sin((-2:0.1:2)*%pi)']
-
             p.mark_mode="off";
-
             p.polyline_style=3;
-
             p.line_style=4;
-
         </scilab:image>
-
         <programlisting role="example"><![CDATA[
-
 // line_styleプロパティの例
-
 clf();
-
 f=gcf();
-
 for i=1:10
-
     plot2d(1:10, i*ones([1:10]), 2);
-
     // line_styleを変更:
-
     f.children.children(1).children.line_style = i;
-
     f.children.children(1).children.thickness = 2;
-
 end
-
 f.children.axes_visible = ["off","on","off"];
-
 f.children.y_label.text = "line_style value";
-
 f.children.y_label.font_size = 3;
-
  ]]></programlisting>
-
         <scilab:image>
-
             clf();
-
             f=gcf();
-
             for i=1:10
-
             plot2d(1:10, i*ones([1:10]), 2);
-
             f.children.children(1).children.line_style = i;
-
             f.children.children(1).children.thickness = 2;
-
             end
-
             f.children.axes_visible = ["off","on","off"];
-
             f.children.y_label.text = "line_style value";
-
             f.children.y_label.font_size = 3;
-
         </scilab:image>
-
     </refsection>
-
     <refsection role="see also">
-
         <title>参照</title>
-
         <simplelist type="inline">
-
             <member>
-
                 <link linkend="set">set</link>
-
             </member>
-
             <member>
-
                 <link linkend="get">get</link>
-
             </member>
-
             <member>
-
                 <link linkend="delete">delete</link>
-
             </member>
-
             <member>
-
                 <link linkend="xpoly">xpoly</link>
-
             </member>
-
             <member>
-
                 <link linkend="xfpoly">xfpoly</link>
-
             </member>
-
             <member>
-
                 <link linkend="xpolys">xpolys</link>
-
             </member>
-
             <member>
-
                 <link linkend="xfpolys">xfpolys</link>
-
             </member>
-
             <member>
-
                 <link linkend="graphics_entities">graphics_entities</link>
-
             </member>
-
         </simplelist>
-
     </refsection>
-
     <refsection>
-
         <title>履歴</title>
-
         <revhistory>
-
             <revision>
-
                 <revnumber>5.4.0</revnumber>
-
                 <revremark>line_style = 0 は廃止予定です.代わりに 1 を使用してください
-
                     (両者は等価で,共に実線を意味します). Scilab 5.4.1以降,値0を使用すると
-
                     エラーを発生します.
-
                 </revremark>
-
+            </revision>
+            <revision>
+                <revnumber>5.5.0</revnumber>
+                <revremark>
+                <itemizedlist>
+                    <listitem>
+                        <literal>.mark_stride</literal> and <literal>.mark_offset</literal>
+                        properties added.
+                    </listitem>
+                    <listitem>
+                        <literal>.datatips</literal> property added.
+                    </listitem>
+                    <listitem>
+                        <literal>.display_function</literal> and
+                        <literal>.display_function_data</literal> properties added.
+                    </listitem>
+                </itemizedlist>
+                </revremark>
             </revision>
             <revision>
                 <revnumber>6.0.0</revnumber>
@@ -1161,9 +616,6 @@ f.children.y_label.font_size = 3;
                   <para>New property <literal>.datatip_display_mode</literal> introduced.</para>
                 </revremark>
             </revision>
-
         </revhistory>
-
     </refsection>
-
-</refentry>
+</refentry>
\ No newline at end of file
index 5948c3f..2a98a4f 100644 (file)
@@ -165,7 +165,7 @@ h.fontsize=20
         <programlisting role="example"><![CDATA[
 // Include an editable table into a figure:
 // Building a table of data:
-params = [" " "Country" "Population [Mh]" "Temp.[°C]" ];
+params = [" " "Country" "Population [Mh]" "Temp.[°C]" ];
 towns = ["Mexico" "Paris" "Tokyo" "Singapour"]';
 country = ["Mexico" "France" "Japan" "Singapour"]';
 pop  = string([22.41 11.77 33.41 4.24]');
index daa204d..410e606 100644 (file)
@@ -197,7 +197,7 @@ h.fontsize=20
         <programlisting role="example"><![CDATA[
 // 編集可能な表を図に含める:
 // データの表を構築:
-params = [" " "Country" "Population [Mh]" "Temp.[A°C]" ];
+params = [" " "Country" "Population [Mh]" "Temp.[°C]" ];
 towns = ["Mexico" "Paris" "Tokyo" "Singapour"]';
 country = ["Mexico" "France" "Japan" "Singapour"]';
 pop  = string([22.41 11.77 33.41 4.24]');
index 74f4bb7..5bad84b 100644 (file)
@@ -16,8 +16,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="en" xml:id="system_getproperty">
     <refnamediv>
         <refname>system_getproperty</refname>
-        <refpurpose>gets the system property
-            indicated by a specified key.
+        <refpurpose>
+           gets the system property for a given JVM key
         </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
                 <td>Path separator (":" on UNIX)</td>
             </tr>
             <tr>
-                <td>line.separator Line separator</td>
-                <td>("\n" on UNIX)</td>
+                <td>line.separator</td>
+                <td>Line separator ("\n" on UNIX)</td>
             </tr>
             <tr>
                 <td>user.name</td>
 system_getproperty('awt.toolkit')
 system_getproperty('file.encoding')
 system_getproperty('file.encoding.pkg')
+
 system_getproperty('java.awt.graphicsenv=sun.awt.Win32GraphicsEnvironment')
 system_getproperty('java.awt.printerjob=sun.awt.windows.WPrinterJob')
 system_getproperty('java.class.path')
@@ -190,11 +191,14 @@ system_getproperty('java.vm.specification.vendor')
 system_getproperty('java.vm.specification.version')
 system_getproperty('java.vm.vendor')
 system_getproperty('java.vm.version')
+
+system_getproperty("jogl.gljpanel.nohw")
 system_getproperty('line.separator')
 system_getproperty('os.arch')
 system_getproperty('os.name')
 system_getproperty('os.version')
 system_getproperty('path.separator')
+
 system_getproperty('sun.arch.data.model')
 system_getproperty('sun.boot.class.path')
 system_getproperty('sun.boot.library.path')
@@ -205,6 +209,7 @@ system_getproperty('sun.io.unicode.encoding')
 system_getproperty('sun.jnu.encoding')
 system_getproperty('sun.management.compiler')
 system_getproperty('sun.os.patch.level')
+
 system_getproperty('user.country')
 system_getproperty('user.dir')
 system_getproperty('user.home')
@@ -214,4 +219,22 @@ system_getproperty('user.timezone')
 system_getproperty('user.variant')
  ]]></programlisting>
     </refsection>
+
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="system_setproperty">system_setproperty</link>
+            </member>
+            <member>
+                <link linkend="getenv">getenv</link>
+            </member>
+            <member>
+                <link linkend="setenv">setenv</link>
+            </member>
+            <member>
+                <link linkend="root_properties">root_properties</link>
+            </member>
+        </simplelist>
+    </refsection>
 </refentry>
index f6f0807..0941ebf 100644 (file)
@@ -16,8 +16,7 @@
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns: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="system_setproperty">
     <refnamediv>
         <refname>system_setproperty</refname>
-        <refpurpose>set a system property
-            indicated by a specified key and value.
+        <refpurpose>set a system property for a given JVM key to a given value.
         </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
@@ -62,4 +61,22 @@ system_setproperty('myproperty','hello')
 system_getproperty('myproperty')
  ]]></programlisting>
     </refsection>
+
+    <refsection role="see also">
+        <title>See also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="system_getproperty">system_getproperty</link>
+            </member>
+            <member>
+                <link linkend="setenv">setenv</link>
+            </member>
+            <member>
+                <link linkend="getenv">getenv</link>
+            </member>
+            <member>
+                <link linkend="root_properties">root_properties</link>
+            </member>
+        </simplelist>
+    </refsection>
 </refentry>
index dd63cd1..1a31578 100644 (file)
 system_getproperty('awt.toolkit')
 system_getproperty('file.encoding')
 system_getproperty('file.encoding.pkg')
+
 system_getproperty('java.awt.graphicsenv=sun.awt.Win32GraphicsEnvironment')
 system_getproperty('java.awt.printerjob=sun.awt.windows.WPrinterJob')
 system_getproperty('java.class.path')
@@ -340,11 +341,14 @@ system_getproperty('java.vm.specification.vendor')
 system_getproperty('java.vm.specification.version')
 system_getproperty('java.vm.vendor')
 system_getproperty('java.vm.version')
+
+system_getproperty("jogl.gljpanel.nohw")
 system_getproperty('line.separator')
 system_getproperty('os.arch')
 system_getproperty('os.name')
 system_getproperty('os.version')
 system_getproperty('path.separator')
+
 system_getproperty('sun.arch.data.model')
 system_getproperty('sun.boot.class.path')
 system_getproperty('sun.boot.library.path')
@@ -355,6 +359,7 @@ system_getproperty('sun.io.unicode.encoding')
 system_getproperty('sun.jnu.encoding')
 system_getproperty('sun.management.compiler')
 system_getproperty('sun.os.patch.level')
+
 system_getproperty('user.country')
 system_getproperty('user.dir')
 system_getproperty('user.home')
@@ -366,5 +371,23 @@ system_getproperty('user.variant')
 
     </refsection>
 
+    <refsection role="see also">
+        <title>参照</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="system_setproperty">system_setproperty</link>
+            </member>
+            <member>
+                <link linkend="getenv">getenv</link>
+            </member>
+            <member>
+                <link linkend="setenv">setenv</link>
+            </member>
+            <member>
+                <link linkend="root_properties">root_properties</link>
+            </member>
+        </simplelist>
+    </refsection>
+
 </refentry>
 
index fd86eb3..a05313c 100644 (file)
@@ -109,5 +109,23 @@ system_getproperty('myproperty')
 
     </refsection>
 
+    <refsection role="see also">
+        <title>参照</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="system_getproperty">system_getproperty</link>
+            </member>
+            <member>
+                <link linkend="setenv">setenv</link>
+            </member>
+            <member>
+                <link linkend="getenv">getenv</link>
+            </member>
+            <member>
+                <link linkend="root_properties">root_properties</link>
+            </member>
+        </simplelist>
+    </refsection>
+
 </refentry>
 
index fe67ba1..e3f7246 100644 (file)
@@ -21,7 +21,7 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Syntax</title>
-        <synopsis>rcond(X)</synopsis>
+        <synopsis>r = rcond(X)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
                     <para>real or complex square matrix</para>
                 </listitem>
             </varlistentry>
+            <varlistentry>
+                <term>r</term>
+                <listitem>
+                    <para>real positive number</para>
+                </listitem>
+            </varlistentry>
         </variablelist>
     </refsection>
     <refsection>
             If not, <literal>rcond(X)</literal> is close to 0.
         </para>
         <para>
-            We compute the 1-norm of A with Lapack/DLANGE, compute its LU decomposition with Lapack/DGETRF
-            and finally estimate the condition with Lapack/DGECON.
+          <note>
+            Estimating the 1-norm inverse condition number with <literal>rcond</literal> is
+            much faster than computing the 2-norm condition number with <literal>cond</literal>.
+            As a trade-off, <literal>rcond</literal> may be less reliable.
+          </note>
+        </para>
+        <para>
+            Algorithm: We compute the 1-norm of X with Lapack/DLANGE, compute its LU decomposition
+            with Lapack/DGETRF, and finally estimate the condition with Lapack/DGECON.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[
-A=diag([1:10]);
+A = diag([1:10]);
 rcond(A)
-A(1,1)=0.000001;
+A(1,1) = 0.000001;
 rcond(A)
- ]]></programlisting>
-        <para>
-            Estimating the 1-norm inverse condition number with <literal>rcond</literal> is
-            much faster than computing the 2-norm condition number with <literal>cond</literal>.
-            As a trade-off, <literal>rcond</literal> may be less reliable.
-        </para>
+]]></programlisting>
+      <para>Comparative benchmark: </para>
         <programlisting role="example"><![CDATA[
-    A=ones(1000,1000);
-    timer();cond(A);timer()
-    timer();1/rcond(A);timer()
+    A = ones(1000, 1000);
+    timer(); cond(A);    timer()
+    timer(); 1/rcond(A); timer()
  ]]></programlisting>
     </refsection>
     <refsection role="see also">
index aa8a0f0..24f1dc0 100644 (file)
@@ -2,6 +2,7 @@
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2008 - INRIA
+ * Copyright (C) 2010 - DIGITEO - Michael Baudin
  *
  * Copyright (C) 2012 - 2016 - Scilab Enterprises
  *
 <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="rcond">
     <refnamediv>
         <refname>rcond</refname>
-        <refpurpose>estimation de l'inverse du conditionnement  </refpurpose>
+        <refpurpose>inverse estimé du conditionnement d'une matrice</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Séquence d'appel</title>
-        <synopsis>rcond(X)</synopsis>
+        <synopsis>r = rcond(X)</synopsis>
     </refsynopsisdiv>
     <refsection>
-        <title>Paramètres</title>
+        <title>Arguments</title>
         <variablelist>
             <varlistentry>
-                <term>X  </term>
+                <term>X</term>
                 <listitem>
                     <para>matrice carrée réelle ou complexe
                     </para>
                 </listitem>
             </varlistentry>
+            <varlistentry>
+                <term>r</term>
+                <listitem>
+                    <para>nombre réel positif
+                    </para>
+                </listitem>
+            </varlistentry>
         </variablelist>
     </refsection>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>rcond(X)</literal> est une estimation de l'inverse du conditionnement de <literal>X</literal> pour la norme l_1.
+            <literal>rcond(X)</literal> est une estimation de l'inverse du conditionnement de
+            <literal>X</literal> pour la norme L_1.
         </para>
         <para>
             Si <literal>X</literal> est bien conditionnée, <literal>rcond(X)</literal> est proche 1.
             Sinon, <literal>rcond(X)</literal> est proche de 0.
         </para>
         <para>
-            <literal>[r,z]=rcond(X)</literal> renvoie <literal>rcond(X)</literal> dans
-            <literal>r</literal> et renvoie aussi <literal>z</literal> tel que <literal>norm(X*z,1) = r*norm(X,1)*norm(z,1)</literal>
+            <note>
+              L'estimation de l'inverse du conditionnement L-1 avec <literal>rcond</literal> est
+              beaucoup (plus de 200x) plus rapide que <literal>cond(X)</literal>. En contrepartie,
+              <literal>rcond</literal> peut être moins fiable.
+            </note>
         </para>
         <para>
-            Ainsi,  si <literal>rcond</literal> est très petit <literal>z</literal> est un vecteur se trouvant dans le noyau de X.
+            Algorithme : la norme L-1 de X est calculée avec Lapack/DLANGE. La décomposition LU
+            de X est effectuée avec Lapack/DGETRF. Finalement, le conditionnement est estimé
+            avec Lapack/DGECON.
         </para>
     </refsection>
     <refsection>
         <title>Exemples</title>
         <programlisting role="example"><![CDATA[
-A=diag([1:10]);
+A = diag([1:10]);
 rcond(A)
-A(1,1)=0.000001;
+A(1,1) = 0.000001;
 rcond(A)
  ]]></programlisting>
+      <para>Bancs-tests comparés cond() / rcond() :</para>
+        <programlisting role="example"><![CDATA[
+    A = ones(1000, 1000);
+    timer(); cond(A);    timer()
+    timer(); 1/rcond(A); timer()
+ ]]></programlisting>
     </refsection>
     <refsection role="see also">
         <title>Voir aussi</title>
index 1d8eb65..9755be3 100644 (file)
@@ -1,5 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2008 - INRIA
  * 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="rcond">
-
     <refnamediv>
-
         <refname>rcond</refname>
-
         <refpurpose>条件数の逆数</refpurpose>
-
     </refnamediv>
-
     <refsynopsisdiv>
-
         <title>呼び出し手順</title>
-
-        <synopsis>rcond(X)</synopsis>
-
+        <synopsis>r = rcond(X)</synopsis>
     </refsynopsisdiv>
-
     <refsection>
-
         <title>引数</title>
-
         <variablelist>
-
             <varlistentry>
-
                 <term>X</term>
-
                 <listitem>
-
                     <para>実数または複素数の正方行列</para>
-
                 </listitem>
-
             </varlistentry>
-
+            <varlistentry>
+                <term>r</term>
+                <listitem>
+                    <para>正の実数</para>
+                </listitem>
+            </varlistentry>
         </variablelist>
-
     </refsection>
-
     <refsection>
-
         <title>説明</title>
-
         <para>
-
             <literal>rcond(X)</literal> は,1-ノルムにおける
-
             <literal>X</literal>の条件の逆数の推定値です.
-
         </para>
-
         <para>
-
             <literal>X</literal>が健全な場合,
-
             <literal>rcond(X)</literal> は 1 に近くなります.
-
             そうでない場合, <literal>rcond(X)</literal> は 0に近くなります.
-
         </para>
-
         <para>
-
-            Aの1-ノルムを Lapack/DLANGEで計算, そのLU分解をLapack/DGETRFで計算,
-
+            <note>
+            <literal>rcond</literal>による1-ノルム逆条件数の推定は,
+            <literal>cond</literal>による2-ノルム条件数の計算よりはるかに高速です.
+            トレードオフとして,<literal>rcond</literal> は若干信頼性が低下する可能性があります.
+            </note>
+        </para>
+        <para>
+            Xの1-ノルムを Lapack/DLANGEで計算, そのLU分解をLapack/DGETRFで計算,
             最後に条件をLapack/DGECONで推定します.
-
         </para>
-
     </refsection>
-
     <refsection>
-
         <title>例</title>
-
         <programlisting role="example"><![CDATA[
-A=diag([1:10]);
+A = diag([1:10]);
 rcond(A)
-A(1,1)=0.000001;
+A(1,1) = 0.000001;
 rcond(A)
  ]]></programlisting>
-
-        <para>
-
-            <literal>rcond</literal>による1-ノルム逆条件数の推定は,
-
-            <literal>cond</literal>による2-ノルム条件数の計算よりはるかに高速です.
-
-            トレードオフとして,<literal>rcond</literal> は若干信頼性が低下する可能性があります.
-
-        </para>
-
-        <programlisting role="example"><![CDATA[
-    A=ones(1000,1000);
-    timer();cond(A);timer()
-    timer();1/rcond(A);timer()
+    <para>比較ベンチマーク</para>
+    <programlisting role="example"><![CDATA[
+    A = ones(1000, 1000);
+    timer(); cond(A);    timer()
+    timer(); 1/rcond(A); timer()
  ]]></programlisting>
-
     </refsection>
-
     <refsection role="see also">
-
         <title>参照</title>
-
         <simplelist type="inline">
-
             <member>
-
                 <link linkend="svd">svd</link>
-
             </member>
-
             <member>
-
                 <link linkend="cond">cond</link>
-
             </member>
-
             <member>
-
                 <link linkend="inv">inv</link>
-
             </member>
-
         </simplelist>
-
     </refsection>
-
-</refentry>
-
+</refentry>
\ No newline at end of file
index 8af9b85..29a8280 100644 (file)
@@ -1,7 +1,8 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2008 - INRIA
+ * Copyright (C) 2010 - DIGITEO - Michael Baudin
  *
  * Copyright (C) 2012 - 2016 - Scilab Enterprises
  *
 <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="rcond" xml:lang="pt">
     <refnamediv>
         <refname>rcond</refname>
-        <refpurpose>número de condicionamento inverso</refpurpose>
+        <refpurpose>número de condicionamento inverso</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
-        <title>Seqüência de Chamamento</title>
-        <synopsis>rcond(X)</synopsis>
+        <title>Seqüência de Chamamento</title>
+        <synopsis>r = rcond(X)</synopsis>
     </refsynopsisdiv>
     <refsection>
-        <title>Parâmetros</title>
+        <title>Parâmetros</title>
         <variablelist>
             <varlistentry>
                 <term>X</term>
                     <para>matriz quadrada de reais ou complexos</para>
                 </listitem>
             </varlistentry>
+            <varlistentry>
+                <term>r</term>
+                <listitem>
+                    <para>número real positivo</para>
+                </listitem>
+            </varlistentry>
         </variablelist>
     </refsection>
     <refsection>
-        <title>Descrição</title>
+        <title>Descrição</title>
         <para>
-            <literal>rcond(X)</literal> é uma estimativa para a recíproca da
-            condição de <literal>X</literal> na norma-1.
+            <literal>rcond(X)</literal> é uma estimativa para a recíproca da
+            condição de <literal>X</literal> na norma-1.
         </para>
         <para>
-            Se <literal>X</literal> é bem condicionada,
-            <literal>rcond(X)</literal> é próximo a 1. Senão,
-            <literal>rcond(X)</literal> é próximo a 0.
+            Se <literal>X</literal> é bem condicionada,
+            <literal>rcond(X)</literal> é próximo a 1. Senão,
+            <literal>rcond(X)</literal> é próximo a 0.
         </para>
         <para>
-            <literal>[r,z]=rcond(X)</literal> ajusta <literal>r</literal> a
-            <literal>rcond(X)</literal> e retorna <literal>z</literal> tal que
-            <literal>norm(X*z,1) = r*norm(X,1)*norm(z,1)</literal>
+          <note>
+            Estimar o número da condição inversa de 1-norma com <literal>rcond</literal> é
+            muito (mais de 200x) mais rápido do que calcular o número da condição de 2 normas com
+            <literal>cond</literal>.
+            Como um trade-off, <literal>rcond</literal> pode ser menos confiável.
+          </note>
         </para>
         <para>
-            Portanto, se <literal>rcond</literal> é pequeno,
-            <literal>z</literal> é um vetor do núcleo.
+            Algoritmo: Calculamos a norma 1 de X com Lapack / DLANGE. Em seguida, sua decomposição
+            de LU é calculada com Lapack / DGETRF. Finalmente, a condição é avaliada com
+            Lapack / DGECON.
         </para>
     </refsection>
     <refsection>
         <title>Exemplos</title>
         <programlisting role="example"><![CDATA[
-A=diag([1:10]);
+A = diag([1:10]);
 rcond(A)
-A(1,1)=0.000001;
+A(1,1) = 0.000001;
 rcond(A)
  ]]></programlisting>
+      <para>Benchmarks comparativos</para>
+        <programlisting role="example"><![CDATA[
+    A = ones(1000, 1000);
+    timer(); cond(A);    timer()
+    timer(); 1/rcond(A); timer()
+ ]]></programlisting>
     </refsection>
     <refsection role="see also">
-        <title>Ver Também</title>
+        <title>Ver Também</title>
         <simplelist type="inline">
             <member>
                 <link linkend="svd">svd</link>
index a723f36..7c66b9b 100644 (file)
@@ -13,6 +13,7 @@
  * along with this program.
  *
  -->
+<!--  module: signal_processing  -->
 <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="delip" xml:lang="en">
     <refnamediv>
         <refname>delip</refname>
index f19be62..244d63a 100644 (file)
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--  module: signal_processing  -->
 <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="delip" xml:lang="fr">
     <refnamediv>
         <refname>delip</refname>
index 97bce84..a256eb0 100644 (file)
@@ -13,6 +13,7 @@
  * along with this program.
  *
  -->
+<!--  module: signal_processing  -->
 <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="delip" xml:lang="ja">
     <refnamediv>
         <refname>delip</refname>
index 6185f3b..b447190 100644 (file)
@@ -13,6 +13,7 @@
  * along with this program.
  *
  -->
+<!--  module: signal_processing  -->
 <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="delip" xml:lang="pt">
     <refnamediv>
         <refname>delip</refname>
index 415407d..ee0533e 100644 (file)
@@ -13,6 +13,7 @@
  * along with this program.
  *
  -->
+<!--  module: signal_processing  -->
 <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="delip" xml:lang="ru">
     <refnamediv>
         <refname>delip</refname>
index a971b6a..44aed4a 100644 (file)
@@ -1,22 +1,28 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
  *
- * This help file was generated from prettyprint.sci using help_from_sci().
+ * The initial version of this help file was generated from prettyprint.sci using help_from_sci().
+ * Following versions have been improved only here.
  *
  -->
-<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="prettyprint" 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: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="prettyprint" xml:lang="en">
     <refnamediv>
         <refname>prettyprint</refname>
-        <refpurpose>From any Scilab datatype and provide a representation to the TeX, LaTeX or MathML formats</refpurpose>
+        <refpurpose>
+          Converts a Scilab object into some corresponding LaTeX, TeX or MathML string(s)
+        </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Syntax</title>
         <synopsis>
-            str = prettyprint(a) // Show the variable a with the default format (LaTeX)
-            str = prettyprint(a, exportFormat) // Show the variable a with the specified format
-            str = prettyprint(a, exportFormat, delim) // As above but change the delimiter
-            str = prettyprint(a, exportFormat, delim, processByElement) // As above but process each element independently
-            str = prettyprint(a,exportFormat, delim, processByElement, isWrapped) // As above Add the special keyword of Tex or LaTeX export
+            str = prettyprint(a)
+            str = prettyprint(a, exportFormat)
+            str = prettyprint(a, exportFormat, delim)
+            str = prettyprint(a, exportFormat, delim, processByElement)
+            str = prettyprint(a, exportFormat, delim, processByElement, isWrapped)
         </synopsis>
     </refsynopsisdiv>
     <refsection>
             <varlistentry>
                 <term>exportFormat</term>
                 <listitem>
-                    <para> is the format, if omitted 'latex' is used by default,
-                        it can be 'latex', 'tex' or 'mathml'.
+                    <para>
+                      is the output format. Possible values are 'latex' (default), 'tex', or 'mathml'.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>delimiter</term>
                 <listitem>
-                    <para> is a string indicating the delimiter to use for the
-                        resulting matrix, it's only used if isWrapped is true. The
-                        delimiter can be '(', '{', '[', '|', '||' or ')'
+                    <para> is a string indicating the delimiter to bracket the whole
+                       resulting matrix. It's only used if <varname>processByElement</varname> is
+                       false. It can be '(' (default), '{', '[', '|', or '||'.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>processByElement</term>
                 <listitem>
-                    <para> is a boolean to indicate if the resulting matrix must
-                        be converted into a single string.
+                  <para> is a boolean: If set to <literal>%f</literal> (default), the result
+                    <varname>str</varname> is a single single representing the whole input
+                    matrix. Otherwise, <varname>str</varname> has as many elements as the input
+                    matrix <varname>a</varname>.
                     </para>
                 </listitem>
             </varlistentry>
                 <listitem>
                     <para> is a boolean to indicate if the result must be wrapped
                         inside delimiters ('$' for latex and tex or nothing for
-                        mathml) to be used with xstring or xtitle
+                        mathml) to be used with xstring or xtitle. The default value is %T (true).
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>str</term>
                 <listitem>
-                    <para> the representation of the variable a</para>
+                  <para> a single string (if <varname>processByElement</varname> is %F),
+                    or a matrix of strings otherwise (with size(str)==size(a)):
+                    the representation of the input <varname>a</varname>.
+                  </para>
                 </listitem>
             </varlistentry>
         </variablelist>