[doc] sciargs() page updated & overhauled 14/21114/2
Samuel GOUGEON [Mon, 4 Nov 2019 00:41:33 +0000 (01:41 +0100)]
Change-Id: Ife45d1906cf5cd72e7e15c6ea4399d57a84064fc

scilab/CHANGES.md
scilab/modules/core/help/en_US/configuration/sciargs.xml
scilab/modules/core/help/fr_FR/configuration/sciargs.xml
scilab/modules/core/help/ja_JP/configuration/sciargs.xml
scilab/modules/core/help/pt_BR/configuration/sciargs.xml
scilab/modules/core/help/ru_RU/configuration/sciargs.xml

index fb0b0cc..28b9a2d 100644 (file)
@@ -105,6 +105,7 @@ Feature changes and additions
   - Default input arguments can be skipped instead of still having to be provided.
   - The result string is better formatted to be easily wrappable and indentable.
 * `mesh2d` has been introduced to compute a 2d mesh from vectors (x,y) of points.
+<<<<<<< HEAD
 * `loadmatfile` is upgraded:
   - Octave native text data files can now be read.
   - Automatic detection of the input data format implemented.
@@ -138,6 +139,9 @@ Feature changes and additions
   - Named colors accepted ; better default colors.
   - Improved placement of labels.
 * `nicholschart` is improved: more neutral default frame color; improved labels positionning; colors can now be specified by their predefined name or "#RRGGBB" hexa code; a structure of handles is now returned to easily postprocess both subframes and the set of labels.
+=======
+* `sciargs()` returns a column instead of formerly a row.
+>>>>>>> 4b177bd2a98... [doc] sciargs() page updated & overhauled
 
 Help pages:
 -----------
index b92acb8..ff5ed44 100644 (file)
@@ -1,5 +1,22 @@
 <?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="en" xml:id="sciargs">
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 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="en" xml:id="sciargs">
     <refnamediv>
         <refname>sciargs</refname>
         <refpurpose>scilab command line arguments</refpurpose>
     <refsection>
         <title>Description</title>
         <para>
-            This function returns a row vector of character strings containing the
-            arguments of the Scilab command line. First <literal>args</literal> entry contains
-            the path of the launched executable file.
+            This function returns a column vector of character strings containing the
+            arguments of the Scilab command line. <literal>args(1)</literal> contains
+            the absolute path and filename of the executable file actually launched
+            (sometimes through a batch file).
         </para>
         <para>
             This function corresponds to the <literal>getarg</literal> function in C language.
     </refsection>
     <refsection>
         <title>Examples</title>
+        <para>
+        While the current Scilab session has been opened through the command
+        </para>
+        <screen><![CDATA[C:\Users\Me> C:\SCIdir\bin\scilab -nw -nb -noatomsautoload -args "Hello %USERNAME%" \"%cd%\"]]></screen>
+        <para>
+            we then get
+        </para>
         <programlisting role="example"><![CDATA[
-args=sciargs()
- ]]></programlisting>
+a = sciargs()
+     ]]></programlisting>
+        <screen><![CDATA[
+--> a = sciargs()
+ a  =
+! c:\SCIdir\bin\WScilex-cli.exe !
+! -nb                           !
+! -noatomsautoload              !
+! -args                         !
+! Hello John                    !
+! 1.2345                        !
+! "C:\Users\Me"                 !
+    ]]></screen>
+        <para>
+        <warning>
+            Let's note that in <literal>scilab -nw</literal> the "-nw" option is used by
+            the <literal>scilab</literal> batch file to route the call to
+            <literal>WScilex-cli.exe</literal>, without forwarding "-nw". Therefore, this one
+            is not returned by <literal>sciargs()</literal>.
+        </warning>
+        </para>
     </refsection>
 
     <refsection role="see also">
         <title>See also</title>
         <simplelist type="inline">
             <member>
+                <link linkend="scilab">scilab</link>
+            </member>
+            <member>
                 <link linkend="getenv">getenv</link>
             </member>
+            <member>
+                <link linkend="macrovar">macrovar</link>
+            </member>
         </simplelist>
     </refsection>
+    <refsection role="history">
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>6.0.0</revnumber>
+                <revdescription>
+                    A column is returned, instead of formerly a row.
+                </revdescription>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>
index 839779e..1d08510 100644 (file)
@@ -1,5 +1,22 @@
 <?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="sciargs">
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 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="sciargs">
     <refnamediv>
         <refname>sciargs</refname>
         <refpurpose>arguments sur la ligne de commande Scilab  </refpurpose>
     <refsection>
         <title>Description</title>
         <para>
-            Cette fonction renvoie un vecteur ligne de chaînes de caractères contenant les
-            arguments de la commande de lancement de Scilab. Le premier terme du vecteur <literal>args</literal> contient le nom complet (avec le chemin) du fichier exécutable de Scilab.
+            Cette fonction renvoie un vecteur colonne de chaînes de caractères contenant les
+            arguments de la commande de lancement de Scilab. Le premier élément
+            <literal>args(1)</literal> contient le chemin absolu et le nom complet du fichier
+            exécutable de Scilab effectivement lancé (parfois via un script batch).
         </para>
         <para>
             Cette fonction correspond à la fonction <literal>getarg</literal> en langage C.
         </para>
     </refsection>
+    <refsection>
+        <title>Exemples</title>
+        <para>
+            While the Scilab current session has been opened through the command
+        </para>
+        <screen><![CDATA[C:\Users\Me> C:\SCIdir\bin\scilab -nw -nb -noatomsautoload -args "Hello %USERNAME%" \"%cd%\"]]></screen>
+        <para>
+            nous obtenons alors
+        </para>
+        <programlisting role="example"><![CDATA[
+a = sciargs()
+     ]]></programlisting>
+        <screen><![CDATA[
+--> a = sciargs()
+ a  =
+! c:\SCIdir\bin\WScilex-cli.exe !
+! -nb                           !
+! -noatomsautoload              !
+! -args                         !
+! Hello John                    !
+! 1.2345                        !
+! "C:\Users\Me"                 !
+    ]]></screen>
+        <para>
+        <warning>
+            Notons qu'avec <literal>scilab -nw</literal>, l'option "-nw" option s'adresse et est
+            utilisée par le script batch <literal>scilab</literal> pour router l'appel effectif
+            de scilab vers <literal>WScilex-cli.exe</literal>, sans lui faire suivre "-nw".
+            Ainsi "-nw" n'apparait-elle pas dans le résultat de <literal>sciargs()</literal>.
+        </warning>
+        </para>
+    </refsection>
     <refsection role="see also">
         <title>Voir aussi</title>
         <simplelist type="inline">
             <member>
+                <link linkend="scilab">scilab</link>
+            </member>
+            <member>
                 <link linkend="getenv">getenv</link>
             </member>
+            <member>
+                <link linkend="macrovar">macrovar</link>
+            </member>
         </simplelist>
     </refsection>
+    <refsection role="history">
+        <title>Historique</title>
+        <revhistory>
+            <revision>
+                <revnumber>6.0.0</revnumber>
+                <revdescription>
+                    Le résultat est en colonne (précédemment un vecteur ligne).
+                </revdescription>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>
index f492c6a..8100a67 100644 (file)
@@ -1,72 +1,96 @@
 <?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="sciargs">
-
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 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="sciargs">
     <refnamediv>
-
         <refname>sciargs</refname>
-
         <refpurpose>scilab コマンドライン引数</refpurpose>
-
     </refnamediv>
-
     <refsynopsisdiv>
-
         <title>呼出し手順</title>
-
         <synopsis>args = sciargs()</synopsis>
-
     </refsynopsisdiv>
-
     <refsection>
-
         <title>説明</title>
-
         <para>
-
-            この関数は,Scilabコマンドライン引数を含む
-
-            文字列の行ベクトルを返します.
-
+            この関数は、Scilabコマンドライン引数を含む 文字列の列ベクトルを返します.
             <literal>args</literal>の最初のエントリには,
-
             実行された実行ファイルのパスが含まれます.
-
         </para>
-
         <para>
-
             この関数はC言語の<literal>getarg</literal>関数と等価です.
-
         </para>
-
     </refsection>
-
     <refsection>
-
         <title>例</title>
-
+        <para>
+            While the current Scilab session has been opened through the command
+        </para>
+        <screen><![CDATA[C:\Users\Me> C:\SCIdir\bin\scilab -nw -nb -noatomsautoload -args "Hello %USERNAME%" \"%cd%\"]]></screen>
+        <para>
+            we then get
+        </para>
         <programlisting role="example"><![CDATA[
-args=sciargs()
- ]]></programlisting>
-
+a = sciargs()
+     ]]></programlisting>
+        <screen><![CDATA[
+--> a = sciargs()
+ a  =
+! c:\SCIdir\bin\WScilex-cli.exe !
+! -nb                           !
+! -noatomsautoload              !
+! -args                         !
+! Hello John                    !
+! 1.2345                        !
+! "C:\Users\Me"                 !
+    ]]></screen>
+        <para>
+        <warning>
+            Let's note that in <literal>scilab -nw</literal> the "-nw" option is used by
+            the <literal>scilab</literal> batch file to route the call to
+            <literal>WScilex-cli.exe</literal>, without forwarding "-nw". Therefore, this one
+            is not returned by <literal>sciargs()</literal>.
+        </warning>
+        </para>
     </refsection>
-
     <refsection role="see also">
-
         <title>参照</title>
-
         <simplelist type="inline">
-
             <member>
-
+                <link linkend="scilab">scilab</link>
+            </member>
+            <member>
                 <link linkend="getenv">getenv</link>
-
             </member>
-
+            <member>
+                <link linkend="macrovar">macrovar</link>
+            </member>
         </simplelist>
-
     </refsection>
-
-</refentry>
-
+    <refsection role="history">
+        <title>履歴</title>
+        <revhistory>
+            <revision>
+                <revnumber>6.0.0</revnumber>
+                <revdescription>
+                    A column is returned, instead of formerly a row.
+                </revdescription>
+            </revision>
+        </revhistory>
+    </refsection>
+</refentry>
\ No newline at end of file
index e744cc8..e0ed3b8 100644 (file)
@@ -1,5 +1,22 @@
 <?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="sciargs" xml:lang="pt">
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 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="sciargs" xml:lang="pt">
     <refnamediv>
         <refname>sciargs</refname>
         <refpurpose>scilab command line arguments</refpurpose>
     </refsynopsisdiv>
     <refsection>
         <title>Descrição</title>
-        <para>Esta função retorna um vetor de strings contendo os argumentos da
-            linha de comando do Scilab. As primeiras entradas de
-            <literal>args</literal> contém o endereço do arquivo executável
-            rodado.
+        <para>
+            Esta função retorna um vetor de strings contendo os argumentos da
+            linha de comando do Scilab. <literal>args(1)</literal> contém
+            o caminho absoluto e o nome do arquivo executável realmente iniciado
+            (às vezes através de um arquivo em lotes).
+        </para>
+        <para>
+            Esta função corresponde a <literal>getarg</literal> na linguagem C.
+        </para>
+    </refsection>
+    <refsection>
+        <title>Exemplos</title>
+        <para>
+            While the current Scilab session has been opened through the command
         </para>
+        <screen><![CDATA[C:\Users\Me> C:\SCIdir\bin\scilab -nw -nb -noatomsautoload -args "Hello %USERNAME%" \"%cd%\"]]></screen>
         <para>
-            Esta função corresponde a <literal>getarg</literal> na linguagem
-            C.
+            we then get
+        </para>
+        <programlisting role="example"><![CDATA[
+a = sciargs()
+     ]]></programlisting>
+        <screen><![CDATA[
+--> a = sciargs()
+ a  =
+! c:\SCIdir\bin\WScilex-cli.exe !
+! -nb                           !
+! -noatomsautoload              !
+! -args                         !
+! Hello John                    !
+! 1.2345                        !
+! "C:\Users\Me"                 !
+    ]]></screen>
+        <para>
+        <warning>
+            Let's note that in <literal>scilab -nw</literal> the "-nw" option is used by
+            the <literal>scilab</literal> batch file to route the call to
+            <literal>WScilex-cli.exe</literal>, without forwarding "-nw". Therefore, this one
+            is not returned by <literal>sciargs()</literal>.
+        </warning>
         </para>
     </refsection>
     <refsection>
-        <title> Ver Também </title>
+        <title>Ver Também </title>
         <simplelist type="inline">
             <member>
+                <link linkend="scilab">scilab</link>
+            </member>
+            <member>
                 <link linkend="getenv">getenv</link>
             </member>
+            <member>
+                <link linkend="macrovar">macrovar</link>
+            </member>
         </simplelist>
     </refsection>
+    <refsection role="history">
+        <title>Histórico</title>
+        <revhistory>
+            <revision>
+                <revnumber>6.0.0</revnumber>
+                <revdescription>
+                    A column is returned, instead of formerly a row.
+                </revdescription>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>
index 81dbfea..2ec1212 100644 (file)
@@ -1,5 +1,22 @@
 <?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="ru" xml:id="sciargs">
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 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="ru" xml:id="sciargs">
     <refnamediv>
         <refname>sciargs</refname>
         <refpurpose>аргументы командной строки Scilab'а</refpurpose>
     <refsection>
         <title>Описание</title>
         <para>
-            Эта функция возвращает вектор-строку символьных строк, содержащую аргументы командной
-            строки Scilab'а. Первый элемент <literal>args</literal> содержит путь до запущенного
-            исполняемого файла.
+            Эта функция возвращает вектор-столбец символьных строк, содержащий аргументы командной
+            строки Scilab. <literal>args(1)</literal> содержит абсолютный путь и имя файла
+            исполняемого файла, фактически запущенного (иногда через пакетный файл).
         </para>
         <para>
             Эта функция соответствует функции <literal>getarg</literal> в языке C.
         </para>
     </refsection>
+    <refsection>
+        <title>Примеры</title>
+        <para>
+            While the current Scilab session has been opened through the command
+        </para>
+        <screen><![CDATA[C:\Users\Me> C:\SCIdir\bin\scilab -nw -nb -noatomsautoload -args "Hello %USERNAME%" \"%cd%\"]]></screen>
+        <para>
+            we then get
+        </para>
+        <programlisting role="example"><![CDATA[
+a = sciargs()
+     ]]></programlisting>
+        <screen><![CDATA[
+--> a = sciargs()
+ a  =
+! c:\SCIdir\bin\WScilex-cli.exe !
+! -nb                           !
+! -noatomsautoload              !
+! -args                         !
+! Hello John                    !
+! 1.2345                        !
+! "C:\Users\Me"                 !
+    ]]></screen>
+        <para>
+        <warning>
+            Let's note that in <literal>scilab -nw</literal> the "-nw" option is used by
+            the <literal>scilab</literal> batch file to route the call to
+            <literal>WScilex-cli.exe</literal>, without forwarding "-nw". Therefore, this one
+            is not returned by <literal>sciargs()</literal>.
+        </warning>
+        </para>
+    </refsection>
     <refsection role="see also">
         <title>Смотрите также</title>
         <simplelist type="inline">
             <member>
+                <link linkend="scilab">scilab</link>
+            </member>
+            <member>
                 <link linkend="getenv">getenv</link>
             </member>
+            <member>
+                <link linkend="macrovar">macrovar</link>
+            </member>
         </simplelist>
     </refsection>
+    <refsection role="history">
+        <title>История</title>
+        <revhistory>
+            <revision>
+                <revnumber>6.0.0</revnumber>
+                <revdescription>
+                    A column is returned, instead of formerly a row.
+                </revdescription>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>