Revision of help page for function. 91/13291/1
Stanislav KROTER [Sat, 30 Nov 2013 10:47:37 +0000 (16:47 +0600)]
Added russian translation of this page.

Change-Id: I794c351f1923b346d2de6d022e331f80149236c3

scilab/modules/functions/help/en_US/function.xml
scilab/modules/functions/help/fr_FR/function.xml
scilab/modules/functions/help/ja_JP/function.xml
scilab/modules/functions/help/pt_BR/function.xml
scilab/modules/functions/help/ru_RU/function.xml [new file with mode: 0644]

index b53698e..14e32bc 100644 (file)
@@ -21,7 +21,7 @@
     </refnamediv>
     <refsection>
         <title>Description</title>
-        <programlisting><![CDATA[ 
+        <programlisting role='no-scilab-exec'><![CDATA[
 function <lhs_arguments>=<function_name><rhs_arguments>
   <statements>
 endfunction
@@ -43,7 +43,7 @@ endfunction
                     <itemizedlist>
                         <listitem>
                             <para>
-                                a comma separated sequence of variable names enclosed in parenthesis, like  <literal>(x1,...,xm)</literal>. Last variable name can be the key word <literal>varargin</literal> (see varargin)
+                                a comma separated sequence of variable names enclosed in parenthesis, like  <literal>(x1,...,xm)</literal>. Last variable name can be the key word <literal>varargin</literal> (see <link linkend="varargin">varargin</link>)
                             </para>
                         </listitem>
                         <listitem>
@@ -61,12 +61,12 @@ endfunction
                     <itemizedlist>
                         <listitem>
                             <para>
-                                a comma separated sequence of variable names enclosed in brackets, like  <literal>[y1,...,yn]</literal>. Last variable name can be the key word <literal>varargout</literal> (see varargout)
+                                a comma separated sequence of variable names enclosed in brackets, like  <literal>[y1,...,yn]</literal>. Last variable name can be the key word <literal>varargout</literal> (see <link linkend="varargout">varargout</link>)
                             </para>
                         </listitem>
                         <listitem>
                             <para>
-                                the sequence <literal>[]</literal> ,if the function has no input argument. In this case the syntax may also be:  <literal>function &lt;function_name&gt;&lt;rhs_arguments&gt;</literal>
+                                the sequence <literal>[]</literal>, if the function has no output argument. In this case the syntax may also be:  <literal>function &lt;function_name&gt;&lt;rhs_arguments&gt;</literal>
                             </para>
                         </listitem>
                     </itemizedlist>
@@ -76,7 +76,7 @@ endfunction
                 <term>&lt;statements&gt;</term>
                 <listitem>
                     <para>
-                        stands for a set of scilab instructions (statements)  This syntax may be used to define function (see <link linkend="functions">functions</link>) inline or in a script file (see <link linkend="exec">exec</link>). For compatibility with old Scilab versions, functions defined in a script file containing only function definitions can be "loaded" into Scilab using the <literal>exec</literal> function.
+                        stands for a set of Scilab instructions (statements). This syntax may be used to define function (see <link linkend="functions">functions</link>) inline or in a script file (see <link linkend="exec">exec</link>). For compatibility with old Scilab versions, functions defined in a script file containing only function definitions can be "loaded" into Scilab using the <function>exec</function> function.
                     </para>
                 </listitem>
             </varlistentry>
@@ -87,16 +87,16 @@ endfunction
             followed by statements in the same line if a comma or a semicolon is
             added at its end.
         </para>
-        <para>
+        <note>
             Note that <literal>&lt;function_name&gt;</literal> must respect some syntax rules (see <link linkend="names">names</link>).
-        </para>
+        </note>
         <para>
             Function definitions can be nested.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 //inline definition (see function)
 function [x,y]=myfct(a,b)
 x=a+b
@@ -105,7 +105,7 @@ endfunction
 
 [x,y]=myfct(3,2)
 
-//a one line function definition
+//an one line function definition
 function y=sq(x),y=x^2,endfunction
 
 sq(3)
@@ -119,7 +119,7 @@ endfunction
 
 foo(%pi/3)
 
-// definition in an script file (see exec)
+// definition in a script file (see exec)
 exec SCI/modules/elementary_functions/macros/asinh.sci;
  ]]></programlisting>
     </refsection>
index 2d11119..e2e50d3 100644 (file)
@@ -21,7 +21,7 @@
     </refnamediv>
     <refsection>
         <title>Description</title>
-        <programlisting><![CDATA[ 
+        <programlisting role='no-scilab-exec'><![CDATA[
 function <arguments_sortie>=<nom_de_la_fonction><arguments_entrée>
   <instructions>
 endfunction
@@ -41,7 +41,7 @@ endfunction
                     <itemizedlist>
                         <listitem>
                             <para>
-                                une liste de noms de variables séparés par des virgules, entourée de parenthèses, comme  <literal>(x1,...,xm)</literal>. Le dernier nom de variable peut être <literal>varargin</literal> (voir varargin)
+                                une liste de noms de variables séparés par des virgules, entourée de parenthèses, comme  <literal>(x1,...,xm)</literal>. Le dernier nom de variable peut être <literal>varargin</literal> (voir <link linkend="varargin">varargin</link>)
                             </para>
                         </listitem>
                         <listitem>
@@ -59,7 +59,7 @@ endfunction
                     <itemizedlist>
                         <listitem>
                             <para>
-                                une liste de noms de variables séparés par des virgules, entourée de crochets, comme  <literal>[y1,...,ym]</literal>. Le dernier nom de variable peut être <literal>varargout</literal> (voir varargout)
+                                une liste de noms de variables séparés par des virgules, entourée de crochets, comme  <literal>[y1,...,ym]</literal>. Le dernier nom de variable peut être <literal>varargout</literal> (voir <link linkend="varargout">varargout</link>)
                             </para>
                         </listitem>
                         <listitem>
@@ -74,7 +74,7 @@ endfunction
                 <term>&lt;instructions&gt;</term>
                 <listitem>
                     <para>
-                        une suite d'instructions Scilab.  Cette syntaxe peut être utilisée pour définir des fonctions (voir <link linkend="functions">functions</link>) en ligne ou dans un script (voir <link linkend="exec">exec</link>). Pour raisons de compatibilité avec les anciennes versions de Scilab, les fonctions définies dans un script ne contenant que des déclarations de fonctions peuvent être chargées dans Scilab avec la fonction <literal>exec</literal>.
+                        une suite d'instructions Scilab.  Cette syntaxe peut être utilisée pour définir des fonctions (voir <link linkend="functions">functions</link>) en ligne ou dans un script (voir <link linkend="exec">exec</link>). Pour raisons de compatibilité avec les anciennes versions de Scilab, les fonctions définies dans un script ne contenant que des déclarations de fonctions peuvent être chargées dans Scilab avec la fonction <function>exec</function>.
                     </para>
                 </listitem>
             </varlistentry>
@@ -83,15 +83,15 @@ endfunction
             La séquence <literal>function &lt;arguments_sortie&gt;=&lt;nom_de_la_fonction&gt;&lt;arguments_entrée&gt;</literal>
             doit apparaître sur une seule ligne. Cette suite peut être suivie d'instructions Scilab si une virgule ou un point-virgule est ajouté à la fin.
         </para>
-        <para>
+        <note>
             Certaines règles ont été établies quant à la syntaxe des noms de fonctions dans Scilab (voir <link linkend="names">names</link>).
-        </para>
+        </note>
         
         <para>Les définitions de fonctions peuvent être imbriquées.</para>
     </refsection>
     <refsection>
         <title>Exemples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 // définition en ligne
 function [x,y]=myfct(a,b)
 x=a+b
index c06a8e5..e909222 100644 (file)
@@ -21,7 +21,7 @@
     </refnamediv>
     <refsection>
         <title>説明</title>
-        <programlisting><![CDATA[ 
+        <programlisting role='no-scilab-exec'><![CDATA[
 function <lhs_arguments>=<function_name><rhs_arguments>
   <statements>
 endfunction
@@ -46,7 +46,7 @@ endfunction
                                 これは,<literal>(x1,...,xm)</literal>のように括弧で括った
                                 カンマ区切りの変数名の一覧となります.
                                 最後の変数名はキーワード<literal>varargin</literal>とすることも可能です
-                                (varargin 参照)
+                                (<link linkend="varargin">varargin</link> 参照)
                             </para>
                         </listitem>
                         <listitem>
@@ -66,7 +66,7 @@ endfunction
                             <para>
                                 これは,<literal>[y1,...,yn]</literal>のように角括弧で括ったカンマ区切りの
                                 変数名の一覧となります.
-                                最後の変数名はキーワード <literal>varargout</literal> ( varargout 参照)とすること
+                                最後の変数名はキーワード <literal>varargout</literal> (<link linkend="varargout">varargout</link> 参照)とすること
                                 が可能です.
                             </para>
                         </listitem>
@@ -85,7 +85,7 @@ endfunction
                 <listitem>
                     <para>Scilab命令(ステートメント)の集合を意味します.
                         この構文は,インラインまたはスクリプトファイル(exec 参照)の中で
-                        関数を定義する (functions 参照)ために使用できます.
+                        関数を定義する (<link linkend="functions">functions</link> 参照)ために使用できます.
                         古いバージョンのScilabとの互換性のため,
                         function 定義のみを含むスクリプトファイルで定義された関数は,
                         <literal>exec</literal>関数によりScilabに"ロードする"ことができます.
@@ -99,14 +99,17 @@ endfunction
             このシーケンスはカンマまたはセミコロンを終端に付けることにより,
             同じ行に命令を続けることができます.
         </para>
+        <note>
+            Note that <literal>&lt;function_name&gt;</literal> must respect some syntax rules (see <link linkend="names">names</link>).
+        </note>
         <para>
             function の定義はネストすることが可能です.
         </para>
     </refsection>
     <refsection>
         <title>例</title>
-        <programlisting role="example"><![CDATA[ 
-//inline definition (see function)
+        <programlisting role="example"><![CDATA[
+//inline definition
 function [x,y]=myfct(a,b)
 x=a+b
 y=a-b
@@ -142,7 +145,7 @@ exec SCI/modules/elementary_functions/macros/asinh.sci;
                 <link linkend="exec">exec</link>
             </member>
             <member>
-                <link linkend="exec">exec</link>
+                <link linkend="names">names</link>
             </member>
         </simplelist>
     </refsection>
index 8827391..396588a 100644 (file)
@@ -10,7 +10,7 @@
  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
  *
  -->
-<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="function" xml:lang="en">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="function" xml:lang="pt">
     <refnamediv>
         <refname>function</refname>
         <refpurpose>abre definição de função</refpurpose>
@@ -21,7 +21,7 @@
     </refnamediv>
     <refsection>
         <title>Descrição</title>
-        <programlisting role=""><![CDATA[ 
+        <programlisting  role='no-scilab-exec'><![CDATA[
 function <lhs_arguments>=<function_name><rhs_arguments>
 <statements>
 endfunction
@@ -43,7 +43,7 @@ endfunction
                             <para>uma seqüência separada por vírgula de nomes de variáveis
                                 encerrada por parênteses, como <literal>(x1,...,xm)</literal>. O
                                 último nome de variável pode ser a palavra-chave
-                                <literal>varargin</literal> (ver varargin)
+                                <literal>varargin</literal> (ver <link linkend="varargin">varargin</link>)
                             </para>
                         </listitem>
                         <listitem>
@@ -64,12 +64,12 @@ endfunction
                             <para>uma seqüência separada por vírgula de nomes de variáveis
                                 encerrada por colchetes, como <literal>[y1,...,yn]</literal>. O
                                 último nome de variável pode ser a palavra-chave
-                                <literal>varargout</literal> (ver varargout)
+                                <literal>varargout</literal> (ver <link linkend="varargout">varargout</link>)
                             </para>
                         </listitem>
                         <listitem>
                             <para>
-                                a seqüência <literal>[]</literal> ,se a função não possui
+                                a seqüência <literal>[]</literal>, se a função não possui
                                 argumentos de saída. neste caso, a sintaxe também, pode ser:
                                 <literal>function
                                     &lt;function_name&gt;&lt;rhs_arguments&gt;
@@ -83,11 +83,11 @@ endfunction
                 <term>&lt;statements&gt;</term>
                 <listitem>
                     <para>conjunto de instruções Scilab (declarações). Esta sintaxe pode
-                        ser usada para definir funções (ver functions) inline ou em arquivo
-                        script (ver exec). Para compatibilidade com versões Scilab antigas,
+                        ser usada para definir funções (ver <link linkend="functions">functions</link>) inline ou em arquivo
+                        script (ver <link linkend="exec">exec</link>). Para compatibilidade com versões Scilab antigas,
                         as funções podem ser definidas em um arquivo script contendo apenas
                         definições de funções podem ser "carregadas" no Scilab através da
-                        função <literal>exec</literal>.
+                        função <function>exec</function>.
                     </para>
                 </listitem>
             </varlistentry>
@@ -100,12 +100,15 @@ endfunction
             por declarações na mesma linha, se uma vírgula ou ponto-e-vírgula for
             adicionado ao seu fim.
         </para>
+        <note>
+            Note that <literal>&lt;function_name&gt;</literal> must respect some syntax rules (see <link linkend="names">names</link>).
+        </note>
         <para>Definições de funções podem ser aninhadas.</para>
     </refsection>
     <refsection>
         <title>Exemplos</title>
-        <programlisting role="example"><![CDATA[ 
-//definição inline (ver functions)
+        <programlisting role="example"><![CDATA[
+//definição inline
 function [x,y]=myfct(a,b)
 x=a+b
 y=a-b
@@ -140,6 +143,9 @@ exec SCI/modules/elementary_functions/macros/asinh.sci;
             <member>
                 <link linkend="exec">exec</link>
             </member>
+            <member>
+                <link linkend="names">names</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
diff --git a/scilab/modules/functions/help/ru_RU/function.xml b/scilab/modules/functions/help/ru_RU/function.xml
new file mode 100644 (file)
index 0000000..1024f37
--- /dev/null
@@ -0,0 +1,162 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) ????-2008 - INRIA
+ *
+ * This file must be used under the terms of the CeCILL.
+ * This source file is licensed as described in the file COPYING, which
+ * you should have received as part of this distribution.  The terms
+ * are also available at
+ * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
+ *
+ -->
+<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="function">
+    <refnamediv>
+        <refname>function</refname>
+        <refpurpose>
+            открывает определение функции
+        </refpurpose>
+    </refnamediv>
+    <refnamediv xml:id="endfunction">
+        <refname>endfunction</refname>
+        <refpurpose>
+            закрывает определение функции
+        </refpurpose>
+    </refnamediv>
+    <refsection>
+        <title>Описание</title>
+        <programlisting role='no-scilab-exec'><![CDATA[
+function <выходные_аргументы>=<имя_функции><входные_аргументы>
+  <операторы>
+endfunction
+ ]]></programlisting>
+        <para>
+            Где:
+        </para>
+        <variablelist>
+            <varlistentry>
+                <term>&lt;имя_функции&gt;</term>
+                <listitem>
+                    <para>
+                        указывает имя функции
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>&lt;входные_аргументы&gt;</term>
+                <listitem>
+                    <para>
+                        указывает список входных аргументов. Он может быть
+                    </para>
+                    <itemizedlist>
+                        <listitem>
+                            <para>
+                                рядом имён переменных, разделённых
+                                запятой и заключённым в круглые скобки,
+                                например <literal>(x1,...,xm)</literal>.
+                                Последнее имя переменной может быть
+                                ключевым словом
+                                <literal>varargin</literal> (см. <link linkend="varargin">varargin</link>);
+                            </para>
+                        </listitem>
+                        <listitem>
+                            <para>
+                                последовательностью <literal>()</literal>
+                                или ничего, если у функции нет входных
+                                аргументов.
+                            </para>
+                        </listitem>
+                    </itemizedlist>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>&lt;выходные_аргументы&gt;</term>
+                <listitem>
+                    <para>
+                        указывает список выходных аргументов. Он может быть
+                    </para>
+                    <itemizedlist>
+                        <listitem>
+                            <para>
+                                рядом имён переменных, заключённым в
+                                квадратные скобки, например <literal>[y1,...,yn]</literal>. Последнее имя переменной может быть ключевым словом <literal>varargout</literal> (см. <link linkend="varargout">varargout</link>);
+                            </para>
+                        </listitem>
+                        <listitem>
+                            <para>
+                                последовательностью <literal>[]</literal>, если у функции нет выходных аргументов. В этом случае синтаксис может быть таким:  <literal>function &lt;имя_функции&gt;&lt;входные_аргументы&gt;</literal>
+                            </para>
+                        </listitem>
+                    </itemizedlist>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>&lt;операторы&gt;</term>
+                <listitem>
+                    <para>
+                        указывает набор Scilab-инструкций (операторов).
+                        Этот синтаксис можно использовать для
+                        определения функции (см. <link linkend="functions">functions</link>) как встраиваемую, либо в файле-сценарии (см. <link linkend="exec">exec</link>). Для совместимости
+                        со старыми версиями Scilab'а функции,
+                        определённые в файле-сценарии, содержащем только
+                        определения функций, могут быть "загружены" в
+                        Scilab используя функцию <function>exec</function>.
+                    </para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+        <para>
+            Последовательность <literal>function &lt;выходные_аргументы&gt;=&lt;имя_функции&gt;&lt;входные_аргументы&gt;</literal>
+            нельзя разделять на несколько строк. После этой последовательности можно ставить в этой же строке операторы, если в конце добавить запятую или точку с запятой.
+        </para>
+        <note>
+            Заметьте, что <literal>&lt;имя_функции&gt;</literal> должно удовлетворять некоторым правилам синтаксиса (см. <link linkend="names">имена</link>).
+        </note>
+        <para>
+            Определения функций могут быть вложенными.
+        </para>
+    </refsection>
+    <refsection>
+        <title>Примеры</title>
+        <programlisting role="example"><![CDATA[
+//определение встраиваемой функции
+function [x,y]=myfct(a,b)
+x=a+b
+y=a-b
+endfunction
+
+[x,y]=myfct(3,2)
+
+//определение функции в одну строку
+function y=sq(x),y=x^2,endfunction
+
+sq(3)
+
+//определение вложенных функций
+function y=foo(x)
+a=sin(x)
+function y=sq(x), y=x^2,endfunction
+y=sq(a)+1
+endfunction
+
+foo(%pi/3)
+
+// определение функции в файле-сценарии (см. exec)
+exec SCI/modules/elementary_functions/macros/asinh.sci;
+ ]]></programlisting>
+    </refsection>
+    <refsection role="see also">
+        <title>Смотрите также</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="functions">functions</link>
+            </member>
+            <member>
+                <link linkend="exec">exec</link>
+            </member>
+            <member>
+                <link linkend="names">имена</link>
+            </member>
+        </simplelist>
+    </refsection>
+</refentry>