Revision of help page for head_comments function 94/13294/2
Stanislav KROTER [Sun, 1 Dec 2013 04:49:40 +0000 (10:49 +0600)]
Added russian translation of this page.

Change-Id: I3aaba475ba05f2d3fef6be5b2f900348992ea242

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

index 85525ba..80b83fe 100644 (file)
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="head_comments">
     <refnamediv>
         <refname>head_comments</refname>
-        <refpurpose>display scilab function header comments</refpurpose>
+        <refpurpose>display Scilab function header comments</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>head_comments(name)
+        <synopsis>
+            head_comments(name)
             head_comments(name,%paths)
         </synopsis>
     </refsynopsisdiv>
             <varlistentry>
                 <term>name</term>
                 <listitem>
-                    <para>character string, the function name</para>
+                    <para>a character string, the function name.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>%paths</term>
                 <listitem>
-                    <para>character string vector, paths where to look for the asscoated sci-file</para>
+                    <para>
+                        a character string vector, paths where to look for the associated sci-file.
+                    </para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>comments(name)</literal> displays the function header comments (like the
-            Matlab help). The comments are read from the associated sci-file. If <literal>name</literal>
-            if a function in a library the sci-file path is those given by the library
-            path (see <literal>lib</literal>). If <literal>name</literal> if a function which is
-            not in a library, a file with name <literal>name.sci</literal> is searched in the
-            directories given by the variable <literal>%paths</literal>
-        </para>
-        <para>
-            Warning, most of the scilab predefined functions have no header comments.
+            <code>head_comments(name)</code> displays the function header comments (like the
+            Matlab help). The comments are read from the associated sci-file. If <varname>name</varname>
+            is a function which is in a library the sci-file path is those given by the library
+            path (see <link linkend="lib">lib</link>). If <varname>name</varname> is a function which is
+            not in a library, a file with name <varname>name</varname><literal>.sci</literal> is searched in the
+            directories given by the variable <varname>%paths</varname>.
         </para>
+        <warning>
+            Warning: most of the Scilab predefined functions have no header comments.
+        </warning>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 head_comments sinc
  ]]></programlisting>
     </refsection>
@@ -64,6 +67,9 @@ head_comments sinc
             <member>
                 <link linkend="help">help</link>
             </member>
+            <member>
+                <link linkend="lib">lib</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
index 1653c21..ae23af8 100644 (file)
     <refsection>
         <title>説明</title>
         <para>
-            <literal>comments(name)</literal> は,
+            <code>head_comments(name)</code> は,
             (Matlabヘルプのように)
             関数ヘッダのコメントを表示します.
             コメントは関連する sci-ファイルから読み込まれます.
-            <literal>name</literal>がライブラリ中の関数の場合,
+            <varname>name</varname>がライブラリ中の関数の場合,
             sci-ファイルはライブラリパスで指定したパスとなります
-            (<literal>lib</literal>参照).
-            <literal>name</literal>がライブラリ中ではない関数の場合,
-            変数<literal>%paths</literal>で指定したディレクトリの中で
-            <literal>name.sci</literal>という名前のファイルが
+            (<link linkend="lib">lib</link>参照).
+            <varname>name</varname>がライブラリ中ではない関数の場合,
+            変数<varname>%paths</varname>で指定したディレクトリの中で
+            <varname>name</varname><literal>.sci</literal>という名前のファイルが
             探されます.
         </para>
-        <para>
+        <warning>
             Scilabのほとんどの定義済みの関数はもはやヘッダコメントを
             有していません.
-        </para>
+        </warning>
     </refsection>
     <refsection>
         <title>例</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 head_comments sinc
  ]]></programlisting>
     </refsection>
@@ -71,6 +71,9 @@ head_comments sinc
             <member>
                 <link linkend="help">help</link>
             </member>
+            <member>
+                <link linkend="lib">lib</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
index 49a91f3..275a4ef 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: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="head_comments" 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: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="head_comments" xml:lang="pt">
     <refnamediv>
         <refname>head_comments</refname>
         <refpurpose>exibe comentários do cabeçalho da função Scilab</refpurpose>
     <refsection>
         <title>Descrição</title>
         <para>
-            <literal>comments(name)</literal> exibe comentários do cabeçalho da
+            <code>head_comments(name)</code> exibe comentários do cabeçalho da
             função (como a ajuda do Matlab). Os comentários são lidos do arquivo sci
-            associado. Se <literal>name</literal> for uma função em uma biblioteca, o
+            associado. Se <varname>name</varname> for uma função em uma biblioteca, o
             endereço do arquivo sci é aquele dado pelo endereço da biblioteca (ver
-            <literal>lib</literal>). Se <literal>name</literal> for uma função que não
-            está na biblioteca, um arquivo de nome <literal>name.sci</literal> é
+            <link linkend="lib">lib</link>). Se <varname>name</varname> for uma função que não
+            está na biblioteca, um arquivo de nome <varname>name</varname><literal>.sci</literal> é
             procurado nos outros diretórios fornecidos pela variável
-            <literal>%paths</literal>
-        </para>
-        <para>AVISO: a maior parte das funções Scilab predefinidas não possui
-            comentários de cabeçalho.
+            <varname>%paths</varname>.
         </para>
+        <warning>
+            AVISO: a maior parte das funções Scilab predefinidas não possui comentários de cabeçalho.
+        </warning>
     </refsection>
     <refsection>
         <title>Exemplos</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 head_comments sinc
  ]]></programlisting>
     </refsection>
@@ -68,6 +68,9 @@ head_comments sinc
             <member>
                 <link linkend="help">help</link>
             </member>
+            <member>
+                <link linkend="lib">lib</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
diff --git a/scilab/modules/functions/help/ru_RU/head_comments.xml b/scilab/modules/functions/help/ru_RU/head_comments.xml
new file mode 100644 (file)
index 0000000..0b50faf
--- /dev/null
@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) ????-2008 - INRIA - Serge STEER <serge.steer@inria.fr>
+ *
+ * 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="head_comments">
+    <refnamediv>
+        <refname>head_comments</refname>
+        <refpurpose>
+            выводит на экран комментарии в начале Scilab-функции
+        </refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Последовательность вызова</title>
+        <synopsis>
+            head_comments(name)
+            head_comments(name,%paths)
+        </synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Аргументы</title>
+        <variablelist>
+            <varlistentry>
+                <term>name</term>
+                <listitem>
+                    <para>
+                        символьная строка, имя функции.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>%paths</term>
+                <listitem>
+                    <para>
+                        вектор символьных строк, пути по которым
+                        разыскивается соответствующий sci-файл.
+                    </para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
+        <title>Описание</title>
+        <para>
+            Команда <code>head_comments(name)</code> выводит на экран
+            комментарии в начале функции (как справка в Matlab'е).
+            Комментарии считываются из соответствующего sci-файла. Если
+            <varname>name</varname> - это имя функции из библиотеки, то
+            путь к sci-файлу тогда указывается путём к библиотеке (см.
+            <link linkend="lib">lib</link>). Если <varname>name</varname> -
+            это функция не из библиотеки, то файл с именем
+            <varname>name</varname><literal>.sci</literal> разыскивается
+            в директориях, указанных переменной <varname>%paths</varname>.
+        </para>
+        <warning>
+            Внимание: большинство предопределённых Scilab-функций не имеет начальных комментариев.
+        </warning>
+    </refsection>
+    <refsection>
+        <title>Примеры</title>
+        <programlisting role="example"><![CDATA[
+head_comments sinc
+ ]]></programlisting>
+    </refsection>
+    <refsection role="see also">
+        <title>Смотрите также</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="help">help</link>
+            </member>
+            <member>
+                <link linkend="lib">lib</link>
+            </member>
+        </simplelist>
+    </refsection>
+</refentry>