ATOMS: Online help : add a summary page
Pierre MARECHAL [Tue, 27 Oct 2009 16:42:37 +0000 (17:42 +0100)]
scilab/modules/atoms/help/en_US/_atomsSummary.xml [new file with mode: 0644]
scilab/modules/atoms/help/en_US/atomsAutoloadAdd.xml
scilab/modules/atoms/help/en_US/atomsAutoloadDel.xml

diff --git a/scilab/modules/atoms/help/en_US/_atomsSummary.xml b/scilab/modules/atoms/help/en_US/_atomsSummary.xml
new file mode 100644 (file)
index 0000000..81b9d72
--- /dev/null
@@ -0,0 +1,190 @@
+<?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="_atomsSummary">
+
+  <refnamediv>
+    <refname>Summary</refname>
+  </refnamediv>
+
+  <!-- ===================================================================== -->
+       <!-- Install/Remove/Update modules -->
+  <!-- ===================================================================== -->
+       
+  <refsection>
+    <title>Install/Remove/Update modules ...</title>
+    <para>
+                       <informaltable border="1">
+                               <tr>
+                                       <td>
+                                               <link linkend="atomsInstall">atomsInstall</link>
+                                       </td>
+                                       <td>
+                                               Install one or several modules
+                                       </td>
+                               </tr>
+                               
+                               <tr>
+                                       <td>
+                                               <link linkend="atomsUpdate">atomsUpdate</link>
+                                       </td>
+                                       <td>
+                                               Update one or several modules
+                                       </td>
+                               </tr>
+                               
+                               <tr>
+                                       <td>
+                                               <link linkend="atomsRemove">atomsRemove</link>
+                                       </td>
+                                       <td>
+                                               Remove one or several modules
+                                       </td>
+                               </tr>
+                               
+                               <tr>
+                                       <td>
+                                               <link linkend="atomsGetInstalled">atomsGetInstalled</link>
+                                       </td>
+                                       <td>
+                                               Get the list of installed external modules
+                                       </td>
+                               </tr>
+                               
+                               <tr>
+                                       <td>
+                                               <link linkend="atomsIsInstalled">atomsIsInstalled</link>
+                                       </td>
+                                       <td>
+                                               Determines whether the module is installed or not
+                                       </td>
+                               </tr>
+                       </informaltable>
+               </para>
+  </refsection>
+       
+  <!-- ===================================================================== -->
+       <!-- Load modules -->
+  <!-- ===================================================================== -->
+       
+  <refsection>
+    <title>Load modules ...</title>
+    <para>
+                       <informaltable border="1">
+                               <tr>
+                                       <td>
+                                               <link linkend="atomsLoad">atomsLoad</link>
+                                       </td>
+                                       <td>
+                                               Load one or several modules
+                                       </td>
+                               </tr>
+                               <tr>
+                                       <td>
+                                               <link linkend="atomsGetLoaded">atomsGetLoaded</link>
+                                       </td>
+                                       <td>
+                                               Get the list of loaded modules
+                                       </td>
+                               </tr>
+                               <tr>
+                                       <td>
+                                               <link linkend="atomsIsLoaded">atomsIsLoaded</link>
+                                       </td>
+                                       <td>
+                                               Determines whether the module is loaded or not
+                                       </td>
+                               </tr>
+                               <tr>
+                                       <td>
+                                               <link linkend="atomsAutoloadList">atomsAutoloadList</link>
+                                       </td>
+                                       <td>
+                                               Get the list of modules registered to autoload at Scilab start.
+                                       </td>
+                               </tr>
+                               <tr>
+                                       <td>
+                                               <link linkend="atomsAutoloadAdd">atomsAutoloadAdd</link>
+                                       </td>
+                                       <td>
+                                               Add one or several modules to autoload system.
+                                       </td>
+                               </tr>
+                               <tr>
+                                       <td>
+                                               <link linkend="atomsAutoloadDel">atomsAutoloadDel</link>
+                                       </td>
+                                       <td>
+                                               Remove one or several modules from autoload system.
+                                       </td>
+                               </tr>
+                       </informaltable>
+               </para>
+  </refsection>
+       
+  <!-- ===================================================================== -->
+       <!-- Repository management -->
+  <!-- ===================================================================== -->
+       
+  <refsection>
+    <title>Manage repositories ...</title>
+    <para>
+                       <informaltable border="1">
+                               <tr>
+                                       <td>
+                                               <link linkend="atomsRepositoryList">atomsRepositoryList</link>
+                                       </td>
+                                       <td>
+                                               Get the list of managed repositories
+                                       </td>
+                               </tr>
+                               <tr>
+                                       <td>
+                                               <link linkend="atomsRepositoryAdd">atomsRepositoryAdd</link>
+                                       </td>
+                                       <td>
+                                               Add one or several URLs to the list of managed repositories
+                                       </td>
+                               </tr>
+                               <tr>
+                                       <td>
+                                               <link linkend="atomsRepositoryDel">atomsRepositoryDel</link>
+                                       </td>
+                                       <td>
+                                               Remove one or several URLs from the list of managed repositories
+                                       </td>
+                               </tr>
+                       </informaltable>
+               </para>
+  </refsection>        
+       
+       
+       
+       
+       
+       
+       
+       
+       
+       
+       
+  <!-- ===================================================================== -->
+  <!-- Authors -->
+  <!-- ===================================================================== -->
+  <refsection>
+    <title>Authors</title>
+    <simplelist type="vert">
+      <member>Pierre MARECHAL - DIGITEO</member>
+    </simplelist>
+  </refsection>
+</refentry>
index 123ccc7..1fd49f6 100644 (file)
                        <varlistentry>
         <term>modules</term>
         <listitem>
+                                       
           <para>
                                                mx1, mx2 or mx3 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 used.
-                                                       </para>
-            </listitem>
-            <listitem>
-              <para>
-                                                               <literal>"3rd column" (optional)</literal>: devoted to module's
-                                                               installed section. 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>
+                                               
+                                               <!-- Section -->
+                                               
+                                               <tr>
+                                                       <td>
+                                                               <emphasis>3rd Col.</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               <emphasis role="strong">Installed section</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               Optionnal
+                                                       </td>
+                                                       <td>
+                                                               If this field is empty or is not present,
+                                                               and <literal>module</literal> is installed in both "user" and
+                                                               "allusers" sections, the section of autoload list is used.
+                                                       </td>
+                                               </tr>
+                                               
+                                       </informaltable>
+                               </listitem>
       </varlistentry>
                        
                        <!-- 2nd input parameter -->
index 70599e5..d083a2c 100644 (file)
           <para>
                                                mx1, mx2 or mx3 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, all versions
-                                                               of the module are removed from the autoload system.
-                                                       </para>
-            </listitem>
-            <listitem>
-              <para>
-                                                               <literal>"3rd column" (optional)</literal>: devoted to module's
-                                                               installed section. If this field is empty or is not present,
-                                                               Modules installed in both "user" and "allusers" sections are searched.
-                                                       </para>
-            </listitem>
-          </itemizedlist>
+                                       
+                                       <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 from the autoload system
+                                                       </td>
+                                               </tr>
+                                               
+                                               <!-- Section -->
+                                               
+                                               <tr>
+                                                       <td>
+                                                               <emphasis>3rd Col.</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               <emphasis role="strong">Installed section</emphasis>
+                                                       </td>
+                                                       <td>
+                                                               Optionnal
+                                                       </td>
+                                                       <td>
+                                                               If this field is empty or is not present, modules installed in
+                                                               both "user" and "allusers" sections are searched.
+                                                       </td>
+                                               </tr>
+                                               
+                                       </informaltable>
+                                       
         </listitem>
       </varlistentry>