sets atomsGetConfig as public function 05/4405/2
Simon GARESTE [Wed, 6 Jul 2011 10:03:57 +0000 (12:03 +0200)]
Change-Id: Ib169a42a946b4002e5bc6e0230d874659ae5b7fa

scilab/modules/atoms/help/en_US/atomsGetConfig.xml [new file with mode: 0644]
scilab/modules/atoms/macros/atomsGetConfig.sci [moved from scilab/modules/atoms/macros/atoms_internals/atomsGetConfig.sci with 92% similarity]

diff --git a/scilab/modules/atoms/help/en_US/atomsGetConfig.xml b/scilab/modules/atoms/help/en_US/atomsGetConfig.xml
new file mode 100644 (file)
index 0000000..9f77103
--- /dev/null
@@ -0,0 +1,205 @@
+<?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="atomsGetConfig">
+  
+       <refnamediv>
+    <refname>atomsGetConfig</refname>
+    <refpurpose>Get ATOMS system parameters</refpurpose>
+  </refnamediv>
+       
+  <!-- ===================================================================== -->
+  <!-- Calling Sequence -->
+  <!-- ===================================================================== -->
+       
+  <refsynopsisdiv>
+    <title>Calling Sequence</title>
+    <synopsis>
+                       result = atomsGetConfig(parameter)
+               </synopsis>
+  </refsynopsisdiv>
+       
+  <!-- ===================================================================== -->
+  <!-- Parameters -->
+  <!-- ===================================================================== -->
+  
+       <refsection>
+    <title>Arguments</title>
+    <variablelist>
+                       
+                       <varlistentry>
+        <term>parameter</term>
+        <listitem>
+          <para>
+                                               single-string matrix
+                                       </para>
+        </listitem>
+                       </varlistentry>
+                       
+                       <varlistentry>
+        <term>result</term>
+        <listitem>
+                                       Value of the parameter
+                               </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>Network</title>
+               <para>
+                       <informaltable border="1">
+                               
+                               <tr>
+                                       <th>Parameter</th>
+                                       <th>Description</th>
+                                       <th>Values</th>
+                               </tr>
+                               
+                               <tr>
+                                       <td>offLine</td>
+                                       <td>
+                                               If set to "True", the system only works with local repositories.
+                                               The offline mode permits the user to install modules from a local
+                                               repository or a local package (hard disk, USB keys, ...) even if
+                                               the network is unreachable.
+                                       </td>
+                                       <td>True/<emphasis role="strong">False</emphasis></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>Automatically 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>atomsGetConfig</literal> returns the value of the parameter given
+       </para>
+  </refsection>
+  <!-- ===================================================================== -->
+  <!-- Examples -->
+  <!-- ===================================================================== -->
+  <refsection>
+    <title>Examples</title>
+    <programlisting role="example">
+<![CDATA[
+// Get value of verbose parameter
+atomsGetConfig('Verbose')
+]]>
+</programlisting>
+  </refsection>
+  <!-- ===================================================================== -->
+  <!-- Authors -->
+  <!-- ===================================================================== -->
+  <refsection>
+    <title>Authors</title>
+    <simplelist type="vert">
+      <member>Simon GARESTE - DIGITEO</member>
+    </simplelist>
+  </refsection>
+</refentry>
 // Get the configuration of the atoms system
 
 function result = atomsGetConfig(field)
+    // Load Atoms Internals lib if it's not already loaded
+    // =========================================================================
+    if ~ exists("atomsinternalslib") then
+        load("SCI/modules/atoms/macros/atoms_internals/lib");
+    end
 
     rhs = argn(2);