Revision of help pages for dirname. 21/11221/2
Stanislav KROTER [Thu, 4 Apr 2013 15:23:50 +0000 (21:23 +0600)]
Substituted HOME by home.

Change-Id: Ib4e9590459deec59a92b5961c3abf95ed4284316

scilab/modules/fileio/help/en_US/path_filename/dirname.xml
scilab/modules/fileio/help/ru_RU/path_filename/dirname.xml

index 1237e9e..9a14b72 100644 (file)
@@ -32,7 +32,9 @@
             <varlistentry>
                 <term>flag</term>
                 <listitem>
-                    <para>optional boolean, used to convert the given path(s) for the current operating system.
+                    <para>
+                        optional boolean, used to convert the given
+                        path(s) for the current operating system.
                         Default value is true (<constant>%t</constant>).
                     </para>
                 </listitem>
             <varlistentry>
                 <term>flagexpand</term>
                 <listitem>
-                    <para>optional boolean, used to expand leading variables in paths.
-                        Only used with flag argument. Default value is true (<constant>%t</constant>).
+                    <para>
+                        optional boolean, used to expand leading
+                        variables in paths. Only used with
+                        <varname>flag</varname> argument. Default value
+                        is true (<constant>%t</constant>).
                     </para>
                 </listitem>
             </varlistentry>
     <refsection>
         <title>Description</title>
         <para>
-            <function>dirname</function> returns the directory paths of the file entries given in <varname>files</varname>.
+            <function>dirname</function> returns the directory paths of the file entries
+            given in <varname>files</varname>.
         </para>
         <para>
-            If <varname>flag</varname> is true the paths are first converted for the current operating system (for example, 'C:/Tmp/folder' will be converted on Windows to 'C:\Tmp\folder').
+            If <varname>flag</varname> is true the paths are first
+            converted for the current operating system (for example,
+            <code>C:/Tmp/folder'</code> will be converted on Windows to
+            <code>'C:\Tmp\folder'</code>).
         </para>
         <para>
-            if <varname>flagexpand</varname> is true, leading path variables (HOME, SCI, SCIHOME, ...) are expanded for the current operating system
-            (for example, 'HOME\tmp' will be converted on Linux to 'home/&lt;user&gt;/tmp', where &lt;user&gt; is the current user logged on).
+            If <varname>flagexpand</varname> is true, leading path
+            variables (<literal>home</literal>,
+            <constant>SCI</constant>, <constant>SCIHOME</constant>,
+            ...) are expanded for the current operating system (for
+            example, <code>'home\tmp'</code> will be converted on
+            GNU/Linux to <literal>'home/&lt;user&gt;/tmp'</literal>,
+            where <literal>&lt;user&gt;</literal> is the current user
+            logged on).
         </para>
         <para>
-            See more details on <varname>flag</varname> and <varname>flagexpand</varname> in <link linkend="pathconvert">pathconvert</link> section.
+            See more details on <varname>flag</varname> and
+            <varname>flagexpand</varname>
+            in <link linkend="pathconvert">pathconvert</link> section.
         </para>
     </refsection>
     <refsection>
index d9274f9..0a5434e 100644 (file)
@@ -3,11 +3,11 @@
  * 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    
+ * are also available at
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
             <varlistentry>
                 <term>files</term>
                 <listitem>
-                    <para>матрица строк, указывающая набор имён файлов</para>
+                    <para>
+                        матрица строк, содержащая пути к файлам.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>flag, flagexpand</term>
+                <term>flag</term>
                 <listitem>
                     <para>
-                        логические необязательные параметры (значение по умолчанию <constant>%t</constant>)
+                        необязательное логическое значение, используемое для
+                        преобразования указанных путей для текущей операционной
+                        системы. Значение по умолчанию ИСТИНА (<constant>%t</constant>).
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>files, dir</term>
+                <term>flagexpand</term>
                 <listitem>
-                    <para>матрицы строк</para>
+                    <para>
+                        необязательный логическое значение, используемое для
+                        составления пути из переменных, идущих впереди. Используется
+                        только вместе с аргументом <varname>flag</varname>. Значение
+                        по умолчанию ИСТИНА (<constant>%t</constant>).
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term>dirs</term>
+                <listitem>
+                    <para>матрица строк.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Описание</title>
         <para>
-            Функция <function>dirname</function> возвращает имя директории из файлов,
-            указанных в <varname>files</varname>.
+            Функция <function>dirname</function> возвращает путь директории, составленный
+            из файлов, указанных в <varname>files</varname>.
+        </para>
+        <para>
+            Если <varname>flag</varname> равен ИСТИНЕ, то пути сначала преобразуются для
+            текущей операционной системы (например, <code>'C:/Tmp/folder'</code> будет
+            преобразован в Windows в <code>'C:\Tmp\folder'</code>).
         </para>
         <para>
-            Если <varname>flag</varname> равен ИСТИНЕ, то файлы сначала
-            преобразуются в целевой тип, указанный переменной
-            <code>getos() == 'Windows'</code>. Более того, если
-            <varname>flagexpand</varname> равен ИСТИНЕ, то начальные строки,
-            такие как <literal>SCIHOME</literal>, <literal>SCI</literal> или
-            <literal>~</literal> расширяются с помощью переменных среды.
+            Если <varname>flagexpand</varname> равен ИСТИНЕ, то переменные в начале пути
+            (<literal>home</literal>, <constant>SCI</constant>, <constant>SCIHOME</constant>,
+            ...) расширяются для текущей операционной системы (например, <code>'home\tmp'</code>
+            будет преобразован в GNU/Linux в <literal>'home/&lt;user&gt;/tmp'</literal>,
+            где <literal>&lt;user&gt;</literal> - это имя учётной записи пользователя).
         </para>
         <para>
-            Заметьте, что <code>dirname(files,%f)</code> может дать
-            ошибочные результаты, если пути, указанные в
-            <varname>files</varname> не соответствуют соглашению, указанному
-            переменной <code>getos() == 'Windows'</code>.
+            Смотрите подробную информацию о <varname>flag</varname> и <varname>flagexpand</varname>
+            в разделе, посвящённому <link linkend="pathconvert">pathconvert</link>.
         </para>
     </refsection>
     <refsection>
         <title>Примеры</title>
-        <programlisting role="example"><![CDATA[ 
-dirs=dirname('SCI/modules/fileio/macros/poo.sci')
-dirs=dirname('SCI/modules\fileio/macros/poo.sci')
-dirs=dirname('SCI/modules\fileio/macros/poo.sci.k')
+        <programlisting role="example"><![CDATA[
+dirs=dirname('/tmp/folder/poo')
+dirs=dirname('/tmp/folder/')
+dirs=dirname('/')
+
+dirs=dirname('C:\tmp\folder\poo')
+dirs=dirname('C:\tmp\folder\')
+dirs=dirname('C:\')
+
+dirs=dirname(['SCI/etc/scilab.start', 'SCI/etc/scilab.quit'])
  ]]></programlisting>
     </refsection>
     <refsection role="see also">