* Bug #11645 fixed - Short description was wrong in atomsGetLoadedPath help page. 56/8556/1
Vincent COUVERT [Mon, 6 Aug 2012 09:40:58 +0000 (11:40 +0200)]
Change-Id: I4cb227aa55e9fef6ebf3aaac7ac1bbff5c0b89b5

scilab/CHANGES_5.4.X
scilab/modules/atoms/help/en_US/atomsGetLoadedPath.xml

index 65fa028..6ab313b 100644 (file)
@@ -12,7 +12,6 @@ Obsolete functions
 Documentation
 =============
 
-
 * Categories have been created for the following modules help pages:
     - Functions (libraries sub-category). See bug #11642.
     - Linear algebra. See bug #11562.
@@ -51,6 +50,8 @@ Bug Fixes
 
 * Bug #11641 fixed - In xmltoformat, parsing of the CHAPTER files was too strict.
 
+* Bug #11645 fixed - Short description was wrong in atomsGetLoadedPath help page.
+
 * Bug #11647 fixed - The phrase "The system cannot find the file specified." in
                      rmdir was not localized.
 
index d01153b..254e007 100644 (file)
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2011 DIGITEO - Simon GARESTE <simon.gareste@scilab.org>
- * 
+ *
  * 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
  *
  -->
 <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" version="5.0-subset Scilab" xml:id="atomsGetLoadedPath" xml:lang="en">
-  <refnamediv>
-    <refname>atomsGetLoadedPath</refname>
-    <refpurpose>Get the list of loaded external modules</refpurpose>
-  </refnamediv>
-  <!-- ===================================================================== -->
-  <!-- Calling Sequence -->
-  <!-- ===================================================================== -->
-  <refsynopsisdiv>
-    <title>Calling Sequence</title>
-    <synopsis>
-      path = atomsGetLoadedPathPath(module)
-    </synopsis>
-  </refsynopsisdiv>
-  <!-- ===================================================================== -->
-  <!-- Parameters -->
-  <!-- ===================================================================== -->
-  <refsection>
-    <title>Arguments</title>
-    <variablelist>
-      <varlistentry>
-        <term>module</term>
-        <listitem>
-          <para>mx1, mx2, mx3 Matrix of strings :</para>
-          <informaltable border="1">
-            <!-- Technical name -->
-            <tr>
-              <td>
-                <emphasis>1st Col.</emphasis>
-              </td>
-              <td>
-                <emphasis role="strong">Technical name</emphasis>
-              </td>
-              <td>
-                Mandatory
-              </td>
-              <td>
-              </td>
-            </tr>
-            <!-- Version -->
-            <tr>
-              <td>
-                <emphasis>2nd Col.</emphasis>
-              </td>
-              <td>
-                <emphasis role="strong">Version</emphasis>
-              </td>
-              <td>
-                Optional
-              </td>
-              <td>
-                If this field is empty or is not present,
-                the most recent version is used
-              </td>
-            </tr>
-            <!-- Section -->
-            <tr>
-              <td>
-                <emphasis>3nd Col.</emphasis>
-              </td>
-              <td>
-                <emphasis role="strong">Section</emphasis>
-              </td>
-              <td>
-                Optional
-              </td>
-              <td>
-                If this field is empty or is not present,
-                "allusers" is used
-              </td>
-            </tr>
-          </informaltable>
-        </listitem>
-        <term>path</term>
-        <para>The path of the given module</para>
-      </varlistentry>
-    </variablelist>
-  </refsection>
-  <!-- ===================================================================== -->
-  <!-- Description -->
-  <!-- ===================================================================== -->
-  <refsection>
-    <title>Description</title>
-    <para>
-      <literal>atomsGetLoadedPath</literal> returns the path of the module given
-    </para>
-  </refsection>
-  <!-- ===================================================================== -->
-  <!-- Examples -->
-  <!-- ===================================================================== -->
-  <refsection>
-    <title>Examples</title>
-    <programlisting role="example"><![CDATA[ 
+    <refnamediv>
+        <refname>atomsGetLoadedPath</refname>
+        <refpurpose>Returns the path of the installation directory of loaded external modules.</refpurpose>
+    </refnamediv>
+    <!-- ===================================================================== -->
+    <!-- Calling Sequence -->
+    <!-- ===================================================================== -->
+    <refsynopsisdiv>
+        <title>Calling Sequence</title>
+        <synopsis>
+            path = atomsGetLoadedPathPath(module)
+        </synopsis>
+    </refsynopsisdiv>
+    <!-- ===================================================================== -->
+    <!-- Parameters -->
+    <!-- ===================================================================== -->
+    <refsection>
+        <title>Arguments</title>
+        <variablelist>
+            <varlistentry>
+                <term>module</term>
+                <listitem>
+                    <para>mx1, mx2, mx3 Matrix of strings :</para>
+                    <informaltable border="1">
+                        <!-- Technical name -->
+                        <tr>
+                            <td>
+                                <emphasis>1st Col.</emphasis>
+                            </td>
+                            <td>
+                                <emphasis role="strong">Technical name</emphasis>
+                            </td>
+                            <td>
+                                Mandatory
+                            </td>
+                            <td>
+                            </td>
+                        </tr>
+                        <!-- Version -->
+                        <tr>
+                            <td>
+                                <emphasis>2nd Col.</emphasis>
+                            </td>
+                            <td>
+                                <emphasis role="strong">Version</emphasis>
+                            </td>
+                            <td>
+                                Optional
+                            </td>
+                            <td>
+                                If this field is empty or is not present,
+                                the most recent version is used
+                            </td>
+                        </tr>
+                        <!-- Section -->
+                        <tr>
+                            <td>
+                                <emphasis>3nd Col.</emphasis>
+                            </td>
+                            <td>
+                                <emphasis role="strong">Section</emphasis>
+                            </td>
+                            <td>
+                                Optional
+                            </td>
+                            <td>
+                                If this field is empty or is not present,
+                                "allusers" is used
+                            </td>
+                        </tr>
+                    </informaltable>
+                </listitem>
+                <term>path</term>
+                <para>The path of the given module</para>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <!-- ===================================================================== -->
+    <!-- Description -->
+    <!-- ===================================================================== -->
+    <refsection>
+        <title>Description</title>
+        <para>
+            <literal>atomsGetLoadedPath</literal> returns the path of the module given
+        </para>
+    </refsection>
+    <!-- ===================================================================== -->
+    <!-- Examples -->
+    <!-- ===================================================================== -->
+    <refsection>
+        <title>Examples</title>
+        <programlisting role="example"><![CDATA[ 
 atomsSetConfig("Verbose","True");
 atomsRepositoryAdd("http://scene1.test.atoms.scilab.org");
 atomsInstall("toolbox_5");
@@ -112,25 +112,25 @@ path = atomsGetLoadedPath("toolbox_5");
 
 atomsRemove("toolbox_5");
  ]]></programlisting>
-  </refsection>
-  <!-- ===================================================================== -->
-  <!-- See also -->
-  <!-- ===================================================================== -->
-  <refsection role="see also">
-    <title>See Also</title>
-    <simplelist type="inline">
-      <member>
-        <link linkend="atomsLoad">atomsLoad</link>
-      </member>
-      <member>
-        <link linkend="atomsLoad">atomsGetLoaded</link>
-      </member>
-      <member>
-        <link linkend="atomsIsLoaded">atomsIsLoaded</link>
-      </member>
-    </simplelist>
-  </refsection>
-  <!-- ===================================================================== -->
-  <!-- Authors -->
-  <!-- ===================================================================== -->
+    </refsection>
+    <!-- ===================================================================== -->
+    <!-- See also -->
+    <!-- ===================================================================== -->
+    <refsection role="see also">
+        <title>See Also</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="atomsLoad">atomsLoad</link>
+            </member>
+            <member>
+                <link linkend="atomsLoad">atomsGetLoaded</link>
+            </member>
+            <member>
+                <link linkend="atomsIsLoaded">atomsIsLoaded</link>
+            </member>
+        </simplelist>
+    </refsection>
+    <!-- ===================================================================== -->
+    <!-- Authors -->
+    <!-- ===================================================================== -->
 </refentry>