ATOMS: online help
Pierre MARECHAL [Wed, 28 Oct 2009 14:35:26 +0000 (15:35 +0100)]
15 files changed:
scilab/modules/atoms/help/en_US/_atomsGettingStarted.xml [new file with mode: 0644]
scilab/modules/atoms/help/en_US/_atomsSummary.xml
scilab/modules/atoms/help/en_US/atomsAutoloadDel.xml
scilab/modules/atoms/help/en_US/atomsAutoloadList.xml
scilab/modules/atoms/help/en_US/atomsDepTreeShow.xml
scilab/modules/atoms/help/en_US/atomsInstall.xml
scilab/modules/atoms/help/en_US/atomsIsInstalled.xml
scilab/modules/atoms/help/en_US/atomsIsLoaded.xml
scilab/modules/atoms/help/en_US/atomsList.xml
scilab/modules/atoms/help/en_US/atomsRemove.xml [new file with mode: 0644]
scilab/modules/atoms/help/en_US/atomsRepositoryDel.xml
scilab/modules/atoms/help/en_US/atomsSearch.xml
scilab/modules/atoms/help/en_US/atomsShow.xml
scilab/modules/atoms/help/en_US/atomsUpdate.xml
scilab/modules/atoms/macros/atomsDepTreeShow.sci

diff --git a/scilab/modules/atoms/help/en_US/_atomsGettingStarted.xml b/scilab/modules/atoms/help/en_US/_atomsGettingStarted.xml
new file mode 100644 (file)
index 0000000..07b6c5b
--- /dev/null
@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) DIGITEO - Pierre MARECHAL <pierre.marechal@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    
+ * 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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="_atomsGettingStarted">
+
+  <refnamediv>
+    <refname>Getting started</refname>
+  </refnamediv>
+       
+  <refsection>
+    <title>Atoms</title>
+    <para>
+                       <itemizedlist>
+                               <listitem>
+                                       <para>
+                                               <emphasis role="strong">Install a module:</emphasis> 
+                                               <programlisting>
+<![CDATA[atomsInstall('nisp')]]>
+                                               </programlisting>
+                                       </para>
+                               </listitem>
+                               <listitem>
+                                       <para>
+                                               <emphasis role="strong">Remove a module:</emphasis> 
+                                               <programlisting>
+<![CDATA[atomsRemove('nisp')]]>
+                                               </programlisting>
+                                       </para>
+                               </listitem>
+                               <listitem>
+                                       <para>
+                                               <emphasis role="strong">Update the module index:</emphasis>
+                                               To update the local module index with the latest changes made in
+                                               repositories, type the following:
+                                               <programlisting>
+<![CDATA[atomsSystemUpdate()]]>
+                                               </programlisting>
+                                       </para>
+                               </listitem>
+                               <listitem>
+                                       <para>
+                                               <emphasis role="strong">Update modules:</emphasis>
+                                               To update the local module index with the latest changes made in
+                                               repositories, type the following:
+                                               <programlisting>
+<![CDATA[atomsUpdate()]]>
+                                               </programlisting>
+                                       </para>
+                               </listitem>
+                       </itemizedlist>
+               </para>
+  </refsection>        
+       
+  <!-- ===================================================================== -->
+  <!-- Authors -->
+  <!-- ===================================================================== -->
+  <refsection>
+    <title>Authors</title>
+    <simplelist type="vert">
+      <member>Pierre MARECHAL - DIGITEO</member>
+    </simplelist>
+  </refsection>
+</refentry>
index 81b9d72..c0eb310 100644 (file)
   </refsection>
        
   <!-- ===================================================================== -->
+       <!-- Information -->
+  <!-- ===================================================================== -->
+       
+  <refsection>
+    <title>Get information ...</title>
+    <para>
+                       <informaltable border="1">
+                               <tr>
+                                       <td>
+                                               <link linkend="atomsList">atomsList</link>
+                                       </td>
+                                       <td>
+                                               List available modules
+                                       </td>
+                               </tr>
+                               <tr>
+                                       <td>
+                                               <link linkend="atomsSearch">atomsSearch</link>
+                                       </td>
+                                       <td>
+                                               Searches for modules
+                                       </td>
+                               </tr>
+                               <tr>
+                                       <td>
+                                               <link linkend="atomsShow">atomsShow</link>
+                                       </td>
+                                       <td>
+                                               Show the caracteristics of a module
+                                       </td>
+                               </tr>
+                               <tr>
+                                       <td>
+                                               <link linkend="atomsDepTreeShow">atomsDepTreeShow</link>
+                                       </td>
+                                       <td>
+                                               Show the dependency tree of a module
+                                       </td>
+                               </tr>
+                       </informaltable>
+               </para>
+  </refsection>        
+       
+  <!-- ===================================================================== -->
        <!-- Repository management -->
   <!-- ===================================================================== -->
        
                </para>
   </refsection>        
        
-       
-       
-       
-       
-       
-       
-       
-       
-       
-       
   <!-- ===================================================================== -->
   <!-- Authors -->
   <!-- ===================================================================== -->
index d083a2c..2421ff3 100644 (file)
@@ -37,7 +37,7 @@
         <term>modules</term>
         <listitem>
           <para>
-                                               mx1, mx2 or mx3 Matrix of strings:
+                                               mx1, mx2 or mx3 character string matrix:
                                        </para>
                                        
                                        <informaltable border="1">
index fd98aca..12b0760 100644 (file)
         </listitem>
                        </varlistentry>
                        
-      <varlistentry>
+                       <varlistentry>
         <term>modules</term>
         <listitem>
-          <para>4xn String matrix :</para>
-          <itemizedlist>
-            <listitem>
-              <para><literal>1st column</literal> : External module's technical name
-                                                       </para>
-                                               </listitem>
-                                               <listitem>
-                                                       <para><literal>2nd column</literal> : External module's version
-                                                       </para>
-            </listitem>
-            <listitem>
-              <para>
-                                                               <literal>3rd column</literal> : External module's installed section
-                                                       </para>
-            </listitem>
-            <listitem>
-              <para>
-                                                               <literal>4th column</literal> : Autoload list section
-                                                       </para>
-            </listitem>
-          </itemizedlist>
-        </listitem>
+                                       
+          <para>
+                                               4xn character string matrix:
+                                       </para>
+                                       
+                                       <informaltable border="1">
+                                               
+                                               <!-- Module's technical name -->
+                                               
+                                               <tr>
+                                                       <td>
+                                                               <emphasis>1st Col.</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               <emphasis role="strong">Module's technical name</emphasis>
+                                                       </td>
+                                               </tr>
+                                               
+                                               <!-- Module's version -->
+                                               
+                                               <tr>
+                                                       <td>
+                                                               <emphasis>2nd Col.</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               <emphasis role="strong">Module's version</emphasis>
+                                                       </td>
+                                               </tr>
+                                               
+                                               <!-- Module's installed section -->
+                                               
+                                               <tr>
+                                                       <td>
+                                                               <emphasis>3rd Col.</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               <emphasis role="strong">Module's installed section</emphasis>
+                                                       </td>
+                                               </tr>
+                                               
+                                               <!-- Autoload list section -->
+                                               
+                                               <tr>
+                                                       <td>
+                                                               <emphasis>4th Col.</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               <emphasis role="strong">Autoload list section</emphasis>
+                                                       </td>
+                                               </tr>
+                                               
+                                       </informaltable>
+                               </listitem>
       </varlistentry>
                        
     </variablelist>
index 0980cdd..07e788e 100644 (file)
@@ -13,7 +13,7 @@
 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="atomsDepTreeShow">
   <refnamediv>
     <refname>atomsDepTreeShow</refname>
-    <refpurpose>Show the dependency tree of an external module</refpurpose>
+    <refpurpose>Show the dependency tree of a module</refpurpose>
   </refnamediv>
   <!-- ===================================================================== -->
   <!-- Calling Sequence -->
@@ -21,7 +21,7 @@
   <refsynopsisdiv>
     <title>Calling Sequence</title>
     <synopsis>
-         atomsDepTreeShow(name[,version])
+         atomsDepTreeShow(module)
        </synopsis>
   </refsynopsisdiv>
   <!-- ===================================================================== -->
   <refsection>
     <title>Parameters</title>
     <variablelist>
-      <varlistentry>
-        <term>name</term>
+                       <varlistentry>
+        <term>module</term>
         <listitem>
+                                       
           <para>
-                       Matrix of strings : External module name
-                 </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>version</term>
-        <listitem>
-          <para>
-                       Matrix of strings : External module version. This is an optional parameter.
-                       If it's not defined, the most recent version of the module is used.
-                 </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>result</term>
-        <listitem>
-          <para>
-                       Matrix of Booleans
-                 </para>
-        </listitem>
+                                               1x1 or 1x2 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>
+                                                               Optionnal
+                                                       </td>
+                                                       <td>
+                                                               If this field is empty or is not present,
+                                                               the most recent version is used
+                                                       </td>
+                                               </tr>
+                                               
+                                       </informaltable>
+                               </listitem>
       </varlistentry>
+                       
     </variablelist>
   </refsection>
   <!-- ===================================================================== -->
index 687f450..2cad383 100644 (file)
                        <varlistentry>
         <term>modules</term>
         <listitem>
+                                       
           <para>
-                                               mx1 or mx2 Matrix of strings:
+                                               mx1, mx2 Matrix of strings:
                                        </para>
-          <itemizedlist>
-            <listitem>
-              <para>
-                                                               <literal>"1st column" (mandatory)</literal>: devoted to module's
-                                                               technical name.
-                                                       </para>
-            </listitem>
-            <listitem>
-              <para>
-                                                               <literal>"2nd column" (optional)</literal>: devoted to module's
-                                                               version. If this field is empty or is not present, the most recent
-                                                               version is installed.
-                                                       </para>
-            </listitem>
-          </itemizedlist>
-        </listitem>
+                                       
+                                       <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>
+                                                               Optionnal
+                                                       </td>
+                                                       <td>
+                                                               If this field is empty or is not present,
+                                                               the most recent version is used
+                                                       </td>
+                                               </tr>
+                                               
+                                       </informaltable>
+                               </listitem>
       </varlistentry>
       
                        <varlistentry>
       <varlistentry>
         <term>result</term>
         <listitem>
-          <para>5xn String matrix :</para>
-          <itemizedlist>
-            <listitem>
-              <para><literal>1st column</literal> : External module's technical name
-                                                       </para>
-                                               </listitem>
-                                               <listitem>
-                                                       <para><literal>2nd column</literal> : External module's version
-                                                       </para>
-            </listitem>
-            <listitem>
-              <para><literal>3rd column</literal> : allusers/user, this parameter tell if
-                                                               the external module has been installed for all users or only for the
-                                                               current user.
-                                                               </para>
-            </listitem>
-            <listitem>
-              <para>
-                                                               <literal>4th column</literal> : External module's installation path
-                                                       </para>
-            </listitem>
-            <listitem>
-              <para><literal>5th column</literal> : I/A, this parameter tell if
-                                                               the external module has been automatically or intentionnaly installed.
-                                                       </para>
-            </listitem>
-          </itemizedlist>
+          <para>5xn character string matrix:</para>
+                                       <informaltable border="1">
+                                               
+                                               <!-- Technical name -->
+                                               
+                                               <tr>
+                                                       <td>
+                                                               <emphasis>1st Col.</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               <emphasis role="strong">Technical name</emphasis>
+                                                       </td>
+                                                       <td>
+                                                       </td>
+                                               </tr>
+                                               
+                                               <!-- Version -->
+                                               
+                                               <tr>
+                                                       <td>
+                                                               <emphasis>2nd Col.</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               <emphasis role="strong">Version</emphasis>
+                                                       </td>
+                                                       <td>
+                                                       </td>
+                                               </tr>
+                                               
+                                               <!-- Section -->
+                                               
+                                               <tr>
+                                                       <td>
+                                                               <emphasis>3rd Col.</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               <emphasis role="strong">Installation section</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               this parameter determines whether the module has been installed
+                                                               for all users or only for the   current user.
+                                                       </td>
+                                               </tr>
+                                               
+                                               <!-- Installation path -->
+                                               
+                                               <tr>
+                                                       <td>
+                                                               <emphasis>4th Col.</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               <emphasis role="strong">Installation path</emphasis>
+                                                       </td>
+                                                       <td>
+                                                       </td>
+                                               </tr>
+                                               
+                                               <!-- Status -->
+                                               
+                                               <tr>
+                                                       <td>
+                                                               <emphasis>5th Col.</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               <emphasis role="strong">Status</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               "I" stands for "Intentionnaly", "A" stands for "Automatically"
+                                                       </td>
+                                               </tr>
+                                               
+                                       </informaltable>
         </listitem>
       </varlistentry>
     </variablelist>
index da46b50..8172fd8 100644 (file)
     <title>Parameters</title>
     <variablelist>
                        
+                       <!-- 1st input parameter -->
+                       
                        <varlistentry>
         <term>modules</term>
         <listitem>
+                                       
           <para>
-                                               mx1 or mx2 Matrix of strings:
+                                               mx1, mx2 Matrix of strings:
                                        </para>
-          <itemizedlist>
-            <listitem>
-              <para>
-                                                               <literal>"1st column" (mandatory)</literal>: devoted to module's
-                                                               technical name.
-                                                       </para>
-            </listitem>
-            <listitem>
-              <para>
-                                                               <literal>"2nd column" (optional)</literal>: devoted to module's
-                                                               version. If this field is empty or is not present, the most recent
-                                                               version is installed.
-                                                       </para>
-            </listitem>
-          </itemizedlist>
-        </listitem>
+                                       
+                                       <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>
+                                                               Optionnal
+                                                       </td>
+                                                       <td>
+                                                               If this field is empty or is not present,
+                                                               module's version is ignored.
+                                                       </td>
+                                               </tr>
+                                               
+                                       </informaltable>
+                               </listitem>
       </varlistentry>
                        
+                       <!-- 2nd input parameter -->
+                       
                        <varlistentry>
         <term>section</term>
         <listitem>
index 6344ff4..15fbb23 100644 (file)
@@ -16,7 +16,7 @@
   </info>
   <refnamediv>
     <refname>atomsIsLoaded</refname>
-    <refpurpose>Check if an external module is loaded or not</refpurpose>
+    <refpurpose>determines whether a module is loaded or not</refpurpose>
   </refnamediv>
   <!-- ===================================================================== -->
   <!-- Calling Sequence -->
@@ -24,7 +24,7 @@
   <refsynopsisdiv>
     <title>Calling Sequence</title>
     <synopsis>
-         result = atomsIsLoaded(name[,version])
+         result = atomsIsLoaded(modules)
        </synopsis>
   </refsynopsisdiv>
   <!-- ===================================================================== -->
   <refsection>
     <title>Parameters</title>
     <variablelist>
-      <varlistentry>
-        <term>name</term>
+                       
+                       <!-- 1st input parameter -->
+                       
+                       <varlistentry>
+        <term>modules</term>
         <listitem>
+                                       
           <para>
-                       Matrix of strings : External module name
-                 </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>version</term>
-        <listitem>
-          <para>
-                       Matrix of strings : External module version. This is an optional parameter.
-                       If it's not defined, the most recent version of the module is used.
-                 </para>
-        </listitem>
+                                               mx1, mx2 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>
+                                                               Optionnal
+                                                       </td>
+                                                       <td>
+                                                               If this field is empty or is not present,
+                                                               module's version is ignored.
+                                                       </td>
+                                               </tr>
+                                               
+                                       </informaltable>
+                               </listitem>
       </varlistentry>
+                       
+                       <!-- Output parameter -->
+                       
       <varlistentry>
         <term>result</term>
         <listitem>
           <para>
-                       Matrix of Booleans
-                 </para>
+                                               mx1 boolean matrix
+                                       </para>
         </listitem>
       </varlistentry>
     </variablelist>
   <!-- ===================================================================== -->
   <refsection>
     <title>Description</title>
-    <para><literal>atomsIsLoaded</literal> return TRUE if the external module is
-               loaded or not.
+    <para><literal>atomsIsLoaded</literal> determines whether a module is loaded or not.
        </para>
   </refsection>
   <!-- ===================================================================== -->
   <!-- ===================================================================== -->
   <refsection>
     <title>Examples</title>
-    <programlisting role="example"><![CDATA[ 
+    <programlisting role="example"><![CDATA[
+
 atomsSetConfig("Verbose","True");
-atomsRepositoryAdd("http://scene1.test.atoms.scilab.org");
-atomsInstall("toolbox_2");
-atomsLoad("toolbox_2");
+atomsRepositoryAdd("http://scene2.test.atoms.scilab.org");
+
+// Install toolbox_4, both 1.0 and 1.1 version
+atomsInstall(["toolbox_4" "1.0"],"user");
+
+// Load the version 1.0
+atomsLoad(["toolbox_4" "1.0"]);
+
 
-atomsIsLoaded(["toolbox_2" "toolbox_4";"toolbox_3" "toolbox_1"])
+// Ignore the module's version
+atomsIsLoaded("toolbox_4")
 
+// With a specific version
+atomsIsLoaded(["toolbox_4" "1.0"])
+
+// Check several modules
+atomsIsLoaded( ["toolbox_4" "1.0" ; "toolbox_4" "1.1" ; "toolbox_1" "1.0" ] )
+
+// Some cleaning ...
+atomsRepositoryDel("http://scene2.test.atoms.scilab.org");
 atomsRemove("toolbox_2");
+
  ]]></programlisting>
   </refsection>
   <!-- ===================================================================== -->
index 1284324..c08ac01 100644 (file)
@@ -40,7 +40,7 @@
     <title>Examples</title>
     <programlisting role="example"><![CDATA[ 
 atomsRepositoryAdd("http://scene1.test.atoms.scilab.org");
-atomsList();
+atomsList()
  ]]></programlisting>
   </refsection>
   <!-- ===================================================================== -->
diff --git a/scilab/modules/atoms/help/en_US/atomsRemove.xml b/scilab/modules/atoms/help/en_US/atomsRemove.xml
new file mode 100644 (file)
index 0000000..03f2849
--- /dev/null
@@ -0,0 +1,288 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) DIGITEO - Pierre MARECHAL <pierre.marechal@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    
+ * 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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="atomsRemove">
+  <info>
+    <pubdate>$LastChangedDate$</pubdate>
+  </info>
+  <refnamediv>
+    <refname>atomsRemove</refname>
+    <refpurpose>Remove one or several modules</refpurpose>
+  </refnamediv>
+  <!-- ===================================================================== -->
+  <!-- Calling Sequence -->
+  <!-- ===================================================================== -->
+  <refsynopsisdiv>
+    <title>Calling Sequence</title>
+    <synopsis>
+         result = atomsRemove(modules[,section])
+       </synopsis>
+  </refsynopsisdiv>
+  <!-- ===================================================================== -->
+  <!-- Parameters -->
+  <!-- ===================================================================== -->
+  <refsection>
+    <title>Parameters</title>
+    <variablelist>
+      
+                       <varlistentry>
+        <term>modules</term>
+        <listitem>
+          <para>
+                                               mx1 or mx2 character string matrix:
+                                       </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>
+                                                               Optionnal
+                                                       </td>
+                                                       <td>
+                                                               If this field is empty or is not present, all versions
+                                                               of the module are removed.
+                                                       </td>
+                                               </tr>
+                                               
+                                       </informaltable>
+                                       
+        </listitem>
+      </varlistentry>
+      
+                       <varlistentry>
+        <term>section</term>
+        <listitem>
+          <para>
+                                               This argument controls the list of sections where search
+                                               modules to remove.
+                                       </para>
+          <para>
+                                               <literal>section</literal> is a single-string and its value should be :
+                                       </para>
+          <itemizedlist>
+            <listitem>
+              <para>
+                                                               <literal>"all"</literal>: Modules to remove are searched in both
+                                                               "user" and "allusers" sections.
+                                                       </para>
+            </listitem>
+            <listitem>
+              <para>
+                                                               <literal>"allusers"</literal>: Modules to remove are only searched in
+                                                               the "allusers" section.
+                                                       </para>
+            </listitem>
+            <listitem>
+              <para>
+                                                               <literal>"user"</literal>: Modules to remove are only searched in
+                                                               the "user" section.
+                                                       </para>
+            </listitem>
+          </itemizedlist>
+                                       <para>
+                                               If SCI is write accessible, "all" is the default value.
+                                               Otherwise, the default value is "user".
+                                       </para>
+        </listitem>
+                       </varlistentry>
+                       
+      <varlistentry>
+        <term>result</term>
+        <listitem>
+          <para>5xn character string matrix:</para>
+                                       
+                                       <informaltable border="1">
+                                               
+                                               <!-- Technical name -->
+                                               
+                                               <tr>
+                                                       <td>
+                                                               <emphasis>1st Col.</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               <emphasis role="strong">Technical name</emphasis>
+                                                       </td>
+                                                       <td>
+                                                       </td>
+                                               </tr>
+                                               
+                                               <!-- Version -->
+                                               
+                                               <tr>
+                                                       <td>
+                                                               <emphasis>2nd Col.</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               <emphasis role="strong">Version</emphasis>
+                                                       </td>
+                                                       <td>
+                                                       </td>
+                                               </tr>
+                                               
+                                               <!-- Section -->
+                                               
+                                               <tr>
+                                                       <td>
+                                                               <emphasis>3rd Col.</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               <emphasis role="strong">Installation section</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               this parameter determines whether the module has been installed
+                                                               for all users or only for the   current user.
+                                                       </td>
+                                               </tr>
+                                               
+                                               <!-- Installation path -->
+                                               
+                                               <tr>
+                                                       <td>
+                                                               <emphasis>4th Col.</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               <emphasis role="strong">Installation path</emphasis>
+                                                       </td>
+                                                       <td>
+                                                       </td>
+                                               </tr>
+                                               
+                                               <!-- Status -->
+                                               
+                                               <tr>
+                                                       <td>
+                                                               <emphasis>5th Col.</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               <emphasis role="strong">Status</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               "I" stands for "Intentionnaly", "A" stands for "Automatically"
+                                                       </td>
+                                               </tr>
+                                               
+                                       </informaltable>
+                                       
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsection>
+       
+  <!-- ===================================================================== -->
+  <!-- Description -->
+  <!-- ===================================================================== -->
+  <refsection>
+    <title>Description</title>
+    <para><literal>atomsRemove</literal> remove one or more modules.
+       </para>
+       
+  </refsection>
+  <!-- ===================================================================== -->
+  <!-- Examples -->
+  <!-- ===================================================================== -->
+  <refsection>
+    <title>Examples</title>
+    <programlisting role="example"><![CDATA[
+
+// Display some additionnal informations
+atomsSetConfig("Verbose","True");
+
+// Load the test repository
+atomsRepositoryAdd("http://scene2.test.atoms.scilab.org");
+
+// install toolbox_4 : both 1.0 and 1.1 versions
+
+
+// Remove all versions of a module
+atomsInstall(["toolbox_4" "1.0";"toolbox_4" "1.1"],"user");
+atomsRemove(["toolbox_4"]);
+
+
+// Remove a specific version
+atomsInstall(["toolbox_4" "1.0";"toolbox_4" "1.1"],"user");
+atomsRemove(["toolbox_4" "1.0"]);
+atomsRemove(["toolbox_4" "1.1"]);
+
+
+// Remove several modules
+atomsInstall(["toolbox_4";"toolbox_3"],"user");
+atomsRemove(["toolbox_4";"toolbox_3"]);
+
+
+// Remove a module from a specific section
+// ! This example needs write access on SCI directory
+
+atomsInstall("toolbox_4","user");
+atomsInstall("toolbox_4","allusers");
+
+disp(atomsGetInstalled());
+atomsRemove("toolbox_4","user");
+disp(atomsGetInstalled());
+atomsRemove("toolbox_4","allusers");
+disp(atomsGetInstalled());
+
+// Unload the test repository
+atomsRepositoryDel("http://scene2.test.atoms.scilab.org");
+
+]]></programlisting>
+  </refsection>
+  <!-- ===================================================================== -->
+  <!-- See also -->
+  <!-- ===================================================================== -->
+  <refsection>
+    <title>See Also</title>
+    <simplelist type="inline">
+      <member>
+        <link linkend="atomsInstall">atomsRemove</link>
+      </member>
+      <member>
+        <link linkend="atomsIsInstalled">atomsIsInstalled</link>
+      </member>
+      <member>
+        <link linkend="atomsGetInstalled">atomsGetInstalled</link>
+      </member>
+    </simplelist>
+  </refsection>
+  <!-- ===================================================================== -->
+  <!-- Authors -->
+  <!-- ===================================================================== -->
+  <refsection>
+    <title>Authors</title>
+    <simplelist type="vert">
+      <member>Pierre MARECHAL - DIGITEO</member>
+    </simplelist>
+  </refsection>
+</refentry>
index 5c343f8..565e72a 100644 (file)
@@ -34,7 +34,7 @@
         <term>url</term>
         <listitem>
           <para>
-                                               Matrix of strings : list of the URLs to remove
+                                               character string matrix: list of the URLs to remove
                                        </para>
         </listitem>
       </varlistentry>
index fd4054c..6fe5866 100644 (file)
@@ -65,7 +65,6 @@
     <programlisting role="example"><![CDATA[ 
 atomsSetConfig("Verbose","True");
 atomsRepositoryAdd("http://scene1.test.atoms.scilab.org");
-
 atomsSearch("toolbox");
 ]]></programlisting>
   </refsection>
index 388dd60..622f611 100644 (file)
@@ -21,7 +21,7 @@
   <refsynopsisdiv>
     <title>Calling Sequence</title>
     <synopsis>
-         atomsShow(name[,version])
+         atomsShow(module)
        </synopsis>
   </refsynopsisdiv>
   <!-- ===================================================================== -->
   <refsection>
     <title>Parameters</title>
     <variablelist>
-      <varlistentry>
-        <term>name</term>
+                       <varlistentry>
+        <term>module</term>
         <listitem>
+                                       
           <para>
-                                               Character string : External module's technical name
+                                               1x1 or 1x2 Matrix of strings:
                                        </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-        <term>version</term>
-        <listitem>
-          <para>
-                                               Character string : External module's version. This is an
-                                               optional parameter. If not defined, the most recent version
-                                               of the module is used.
-                                       </para>
-        </listitem>
+                                       
+                                       <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>
+                                                               Optionnal
+                                                       </td>
+                                                       <td>
+                                                               If this field is empty or is not present,
+                                                               the most recent version is used
+                                                       </td>
+                                               </tr>
+                                               
+                                       </informaltable>
+                               </listitem>
       </varlistentry>
+                       
     </variablelist>
   </refsection>
   <!-- ===================================================================== -->
index f82ea7b..11be8ac 100644 (file)
@@ -22,7 +22,7 @@
     <title>Calling Sequence</title>
     <synopsis>
          result = atomsUpdate()
-         result = atomsUpdate(name[,allusers]])
+         result = atomsUpdate(name[,section]])
        </synopsis>
   </refsynopsisdiv>
   <!-- ===================================================================== -->
   <refsection>
     <title>Parameters</title>
     <variablelist>
+                       
+                       <!-- First input argument -->
+                       
       <varlistentry>
         <term>name</term>
         <listitem>
           <para>
-                       Matrix of strings : External module name
-                 </para>
+                                               1xn character string matrix  : module's technical name
+                                       </para>
         </listitem>
       </varlistentry>
-      <varlistentry>
-        <term>allusers</term>
+                       
+                       <!-- Second input argument -->
+                       
+                       <varlistentry>
+        <term>section</term>
         <listitem>
           <para>
-                       A boolean : if this parameter is equal to TRUE (%T), the external module
-                       is installed for all users of the computer and is located in
-                       SCI/contrib.
+                                               This argument controls the list of sections where search
+                                               modules to update.
+                                       </para>
+          <para>
+                                               <literal>section</literal> is a single-string and its value should be :
+                                       </para>
+          <itemizedlist>
+            <listitem>
+              <para>
+                                                               <literal>"all"</literal>: Modules to remove are searched in both
+                                                               "user" and "allusers" sections.
+                                                       </para>
+            </listitem>
+            <listitem>
+              <para>
+                                                               <literal>"allusers"</literal>: Modules to remove are only searched in
+                                                               the "allusers" section.
+                                                       </para>
+            </listitem>
+            <listitem>
+              <para>
+                                                               <literal>"user"</literal>: Modules to remove are only searched in
+                                                               the "user" section.
+                                                       </para>
+            </listitem>
+          </itemizedlist>
+                                       <para>
+                                               If SCI is write accessible, "all" is the default value.
+                                               Otherwise, the default value is "user".
+                                       </para>
+        </listitem>
+                       </varlistentry>
                        
-                       If allusers is set to TRUE (%T) and the directory SCI/contrib/ is not
-                       write accessible, atomsUpdate returns an error.
+                       <!-- Outpu argument -->
                        
-                       if this parameter is equal to FALSE (%T), the external module is only
-                       installed for the current user and is loacted in SCIHOME/atoms.
-                 </para>
-        </listitem>
-      </varlistentry>
       <varlistentry>
         <term>result</term>
         <listitem>
           <para>
-                       
-                 </para>
+                                               
+                                       </para>
         </listitem>
       </varlistentry>
     </variablelist>
   <!-- ===================================================================== -->
   <refsection>
     <title>Examples</title>
-    <programlisting role="example"><![CDATA[ 
+    <programlisting role="example">
+<![CDATA[
+
 atomsSetConfig("Verbose","True");
 atomsRepositoryAdd("http://scene1.test.atoms.scilab.org");
+
+// Install toolbox_5
 atomsInstall("toolbox_5");
+
+disp(atomsGetInstalled());
+
+// Load the 2nd scenario in which toolbox_4 has been updated:
+// toolbox_4 version 1.1 has been added
+// (toolbox_4 is a dependency of toolbox_5)
+
 atomsRepositoryDel("http://scene1.test.atoms.scilab.org");
 atomsRepositoryAdd("http://scene2.test.atoms.scilab.org");
 
-atomsUpdate();
+// Update toolbox_5
+atomsUpdate("toolbox_5");
+disp(atomsGetInstalled());
 
+// Some cleaning
+atomsRepositoryDel("http://scene2.test.atoms.scilab.org");
 atomsRemove("toolbox_5");
- ]]></programlisting>
+
+]]>
+               </programlisting>
   </refsection>
   <!-- ===================================================================== -->
   <!-- See also -->
index 6726ba7..9dfa15b 100644 (file)
@@ -42,11 +42,11 @@ function atomsDepTreeShow(package)
        // =========================================================================
        
        if type(package) <> 10 then
-               error(msprintf(gettext("%s: Wrong type for input argument #%d: String array expected.\n"),"atomsGetLoadedPath",1));
+               error(msprintf(gettext("%s: Wrong type for input argument #%d: String array expected.\n"),"atomsDepTreeShow",1));
        end
        
        if size(package(1,:),"*") > 2 then
-               error(msprintf(gettext("%s: Wrong size for input argument #%d: 1x1 or 1x2 string matrix expected.\n"),"atomsGetLoadedPath",1));
+               error(msprintf(gettext("%s: Wrong size for input argument #%d: 1x1 or 1x2 string matrix expected.\n"),"atomsDepTreeShow",1));
        end
        
        // Get the dependency tree