ATOMS: atomsSetConfig online help
Pierre MARECHAL [Sun, 1 Nov 2009 22:03:08 +0000 (23:03 +0100)]
scilab/modules/atoms/help/en_US/_atomsGettingStarted.xml
scilab/modules/atoms/help/en_US/_atomsSummary.xml
scilab/modules/atoms/help/en_US/atomsSetConfig.xml [new file with mode: 0644]
scilab/modules/atoms/help/images/dialog-information.png [new file with mode: 0644]

index 07b6c5b..cb62ca4 100644 (file)
   </refnamediv>
        
   <refsection>
+    <title>Introduction</title>
+    <para>
+               This page teaches how to get started with ATOMS module manager on the
+                       scilab platform towards a session example. It describes how one can install
+                       a module and load it in Scilab environment.
+               </para>
+       </refsection>
+       
+  <refsection>
     <title>Atoms</title>
     <para>
                        <itemizedlist>
+                               
                                <listitem>
                                        <para>
-                                               <emphasis role="strong">Install a module:</emphasis> 
+                                               <emphasis role="strong">Configure ATOMS to display extra-informations</emphasis> 
                                                <programlisting>
-<![CDATA[atomsInstall('nisp')]]>
+<![CDATA[-->atomsSetConfig('Verbose','True');]]>
                                                </programlisting>
                                        </para>
                                </listitem>
+                               
                                <listitem>
                                        <para>
-                                               <emphasis role="strong">Remove a module:</emphasis> 
+                                               <emphasis role="strong">List available modules</emphasis> 
                                                <programlisting>
-<![CDATA[atomsRemove('nisp')]]>
+<![CDATA[
+-->atomsList();
+
+      ampl_toolbox - An interface to load .nl files created by AMPL
+       ANN_Toolbox - ANN Toolbox
+            conmin - A Scilab interface to the conmin optimization method
+             CUTEr - Testing environment for optimization and linear algebra solvers
+       dace_scilab - This is a conversion of the well known DACE kriging toolbox for Matlab.
+       dde_toolbox - Dynamic Data Exchange client for Scilab
+        HYDROGRv50 - Models and function for operational hydrology
+           lolimot - A fast neural network - LOcal LInear MOdel Tree
+      module_lycee - Scilab pour les lycĂ©es
+              NISP - Non Intrusive Spectral Projection
+           plotlib - "Matlab-like" Plotting library for Scilab
+          scilab2c - Translate Scilab code into C code
+            scipad - Scipad 7.20
+           simplex - This package contains the simplex optimization method
+   sndfile_toolbox - Read & write sound files
+           stixbox - Statistics toolbox for Scilab 5.2
+]]>
                                                </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:
+                                               <emphasis role="strong">Install a module</emphasis>
+                                               Installing a module download and extract it.
                                                <programlisting>
-<![CDATA[atomsSystemUpdate()]]>
+<![CDATA[
+-->atomsInstall('NISP');
+
+    NISP (2.1) will be installed in the 'allusers' section
+    Installing NISP (2.1) ... success
+
+]]>
                                                </programlisting>
                                        </para>
                                </listitem>
+                                       
+                               <listitem>
+                                       <para>
+                                               <emphasis role="strong">Load a module</emphasis>
+                                               The module is installed but it's not loaded in the scilab environment
+                                               and its functionnalities are not available yet.
+                                       </para>
+                                       <para>
+                                               <inlinemediaobject>
+                                                       <imageobject>
+                                                               <imagedata fileref="../images/dialog-information.png"/>
+                                                       </imageobject>
+                                               </inlinemediaobject>
+                                               By default, a module is added to the list of modules to load at Scilab
+                                               start when it's installed.
+                                               <emphasis>
+                                               (&gt;&gt; More information on the autoload
+                                               system :
+                                                       <simplelist type="inline">
+                                                               <member>
+                                                                       <link linkend="atomsAutoloadList">atomsAutoloadList</link>
+                                                               </member>
+                                                               <member>
+                                                                       <link linkend="atomsAutoloadAdd">atomsAutoloadAdd</link>
+                                                               </member>
+                                                               <member>
+                                                                       <link linkend="atomsAutoloadDel">atomsAutoloadDel</link>
+                                                               </member>
+                                                       </simplelist>
+                                               ).
+                                               </emphasis>
+                                       </para>
+                                               
+                                       <para>
+                                               
+                                               <programlisting>
+
+                       <![CDATA[
+-->atomsLoad('NISP');
+      
+    Start NISP Toolbox
+      Load gateways
+      Load help
+      Load demos
+]]>
+                                       </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:
+                                               <emphasis role="strong">Remove a module:</emphasis> 
                                                <programlisting>
-<![CDATA[atomsUpdate()]]>
+<![CDATA[
+-->atomsRemove NISP
+  
+    NISP (2.1) will be removed from the 'allusers' section
+    the package NISP (2.1) is currently loaded, It will removed at next Scilab restart
+]]>
                                                </programlisting>
                                        </para>
                                </listitem>
index 1ebd4ba..2765b54 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="atoms">
 
   <refnamediv>
-    <refname>atoms</refname>
+    <refname>Functions Summary</refname>
   </refnamediv>
 
   <!-- ===================================================================== -->
                </para>
   </refsection>        
        
+       <!-- ===================================================================== -->
+       <!-- Atoms  -->
+  <!-- ===================================================================== -->
+       
+  <refsection>
+    <title>Manage ATOMS system ...</title>
+    <para>
+                       <informaltable border="1">
+                               <tr>
+                                       <td>
+                                               <link linkend="atomsSystemUpdate">atomsSystemUpdate</link>
+                                       </td>
+                                       <td>
+                                               Update the list of available modules
+                                       </td>
+                               </tr>
+                               <tr>
+                                       <td>
+                                               <link linkend="atomsSetConfig">atomsSetConfig</link>
+                                       </td>
+                                       <td>
+                                               Manage ATOMS parameters
+                                       </td>
+                               </tr>
+                       </informaltable>
+               </para>
+  </refsection>
+       
   <!-- ===================================================================== -->
   <!-- Authors -->
   <!-- ===================================================================== -->
diff --git a/scilab/modules/atoms/help/en_US/atomsSetConfig.xml b/scilab/modules/atoms/help/en_US/atomsSetConfig.xml
new file mode 100644 (file)
index 0000000..b6f2639
--- /dev/null
@@ -0,0 +1,191 @@
+<?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="atomsSetConfig">
+  
+       <refnamediv>
+    <refname>atomsSetConfig</refname>
+    <refpurpose>Manage ATOMS system parameters</refpurpose>
+  </refnamediv>
+       
+  <!-- ===================================================================== -->
+  <!-- Calling Sequence -->
+  <!-- ===================================================================== -->
+       
+  <refsynopsisdiv>
+    <title>Calling Sequence</title>
+    <synopsis>
+                       result = atomsSetConfig(parameter,value)
+               </synopsis>
+  </refsynopsisdiv>
+       
+  <!-- ===================================================================== -->
+  <!-- Parameters -->
+  <!-- ===================================================================== -->
+  
+       <refsection>
+    <title>Parameters</title>
+    <variablelist>
+                       
+                       <varlistentry>
+        <term>parameter</term>
+        <listitem>
+          <para>
+                                               single-string matrix
+                                       </para>
+        </listitem>
+                       </varlistentry>
+                       
+                       <varlistentry>
+        <term>value</term>
+        <listitem>
+          <para>
+                                               single-string matrix
+                                       </para>
+        </listitem>
+                       </varlistentry>
+                       
+                       <varlistentry>
+        <term>result</term>
+        <listitem>
+                                       Number of changed parameters
+                               </listitem>
+      </varlistentry>
+                       
+    </variablelist>
+  </refsection>
+       
+       <refsection>
+    <title>Proxy</title>
+               <para>
+                       <informaltable border="1">
+                               
+                               <tr>
+                                       <th>Parameter</th>
+                                       <th>Description</th>
+                                       <th>Values</th>
+                               </tr>
+                               
+                               <tr>
+                                       <td>useProxy</td>
+                                       <td>Use/Don't use proxies</td>
+                                       <td><emphasis role="strong">True</emphasis>/False</td>
+                               </tr>
+                               
+                               <tr>
+                                       <td>proxyHost</td>
+                                       <td>the hostname (IP or DNS name)</td>
+                                       <td></td>
+                               </tr>
+                               
+                               <tr>
+                                       <td>proxyPort</td>
+                                       <td>the port</td>
+                                       <td></td>
+                               </tr>
+                               
+                               <tr>
+                                       <td>proxyUser</td>
+                                       <td>Specify the username for authentication on a proxy server</td>
+                                       <td></td>
+                               </tr>
+                               
+                               <tr>
+                                       <td>proxyPassword</td>
+                                       <td>Specify the password for authentication on a proxy server</td>
+                                       <td></td>
+                               </tr>
+                               
+                       </informaltable>
+               </para>
+       </refsection>
+       
+       <refsection>
+    <title>Autoload System</title>
+               <para>
+                       <informaltable border="1">
+                               
+                               <tr>
+                                       <th>Parameter</th>
+                                       <th>Description</th>
+                                       <th>Values</th>
+                               </tr>
+                               
+                               <tr>
+                                       <td>autoload</td>
+                                       <td>Enable/Disable autoload system</td>
+                                       <td><emphasis role="strong">True</emphasis>/False</td>
+                               </tr>
+                               
+                               <tr>
+                                       <td>autoloadAddAfterInstall</td>
+                                       <td>Automaticaly add a module to the list of module to autoload at Scilab start</td>
+                                       <td><emphasis role="strong">True</emphasis>/False</td>
+                               </tr>
+                       </informaltable>
+               </para>
+       </refsection>
+       
+       <refsection>
+    <title>Miscellenous</title>
+               <para>
+                       <informaltable border="1">
+                               
+                               <tr>
+                                       <th>Parameter</th>
+                                       <th>Description</th>
+                                       <th>Values</th>
+                               </tr>
+                               
+                               <tr>
+                                       <td>verbose</td>
+                                       <td>Display or not extra-informations</td>
+                                       <td>True/<emphasis role="strong">False</emphasis></td>
+                               </tr>
+                               
+                       </informaltable>
+               </para>
+       </refsection>
+       
+  <!-- ===================================================================== -->
+  <!-- Description -->
+  <!-- ===================================================================== -->
+  <refsection>
+    <title>Description</title>
+    <para><literal>atomsSetConfig</literal> returns the list of modules registered to autoload
+       </para>
+  </refsection>
+  <!-- ===================================================================== -->
+  <!-- Examples -->
+  <!-- ===================================================================== -->
+  <refsection>
+    <title>Examples</title>
+    <programlisting role="example">
+<![CDATA[
+// Display extra-informations
+atomsSetConfig('Verbose','True')
+
+// Disable autoload system
+atomsSetConfig('autoload','False')
+]]>
+</programlisting>
+  </refsection>
+  <!-- ===================================================================== -->
+  <!-- Authors -->
+  <!-- ===================================================================== -->
+  <refsection>
+    <title>Authors</title>
+    <simplelist type="vert">
+      <member>Pierre MARECHAL - DIGITEO</member>
+    </simplelist>
+  </refsection>
+</refentry>
diff --git a/scilab/modules/atoms/help/images/dialog-information.png b/scilab/modules/atoms/help/images/dialog-information.png
new file mode 100644 (file)
index 0000000..8851b99
Binary files /dev/null and b/scilab/modules/atoms/help/images/dialog-information.png differ