Add help about repositories management
Pierre MARECHAL [Fri, 19 Jun 2009 08:38:47 +0000 (10:38 +0200)]
scilab/modules/atoms/help/en_US/atomsAddRepository.xml [new file with mode: 0644]
scilab/modules/atoms/help/en_US/atomsDelRepository.xml [new file with mode: 0644]
scilab/modules/atoms/help/en_US/atomsRepositories.xml [new file with mode: 0644]
scilab/modules/atoms/help/fr_FR/addchapter.sce

diff --git a/scilab/modules/atoms/help/en_US/atomsAddRepository.xml b/scilab/modules/atoms/help/en_US/atomsAddRepository.xml
new file mode 100644 (file)
index 0000000..cdc0b78
--- /dev/null
@@ -0,0 +1,132 @@
+<?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="atomsAddRepository">
+  <info>
+       <pubdate>$LastChangedDate$</pubdate>
+  </info>
+  <refnamediv>
+    <refname>atomsAddRepository</refname>
+    <refpurpose>Add one or several URLs to the list of managed repositories</refpurpose>
+  </refnamediv>
+  
+  <!-- ===================================================================== -->
+  <!-- Calling Sequence -->
+  <!-- ===================================================================== -->
+
+  <refsynopsisdiv>
+    <title>Calling Sequence</title>
+    <synopsis>
+         nbAdd = atomsAddRepository(url[,allusers])
+       </synopsis>
+  </refsynopsisdiv>
+  
+  <!-- ===================================================================== -->
+  <!-- Parameters -->
+  <!-- ===================================================================== -->
+  
+  <refsection>
+    <title>Parameters</title>
+       
+    <variablelist>
+      <varlistentry>
+        <term>url</term>
+        <listitem>
+          <para>
+                       Matrix of strings : list of the URLs to add
+                 </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>allusers</term>
+        <listitem>
+          <para>
+                       A boolean : if this parameter is equal to TRUE (%T), URLs are added
+                       for all users of the computer. The list of available URL for all users
+                       is defined in SCI/.atoms/repositories.
+                       
+                       If allusers is set to TRUE (%T) and the directory SCI/.atoms/ is not
+                       write accessible, atomsAddRepository will produce an error.
+                       
+                       if this parameter is equal to FALSE (%T), the URL is only added
+                       for the current user. The list of URL only available for the current
+                       user is defined in SCIHOME/atoms/repositories.
+                 </para>
+        </listitem>
+      </varlistentry>
+         
+      <varlistentry>
+        <term>nbAdd</term>
+        <listitem>
+          <para>
+                       An integer : the number of repositories successfully added.
+                 </para>
+        </listitem>
+      </varlistentry>
+         
+    </variablelist>
+  </refsection>
+  
+  <!-- ===================================================================== -->
+  <!-- Description -->
+  <!-- ===================================================================== -->
+  
+  <refsection>
+    <title>Description</title>
+    <para>
+         
+       </para>
+  </refsection>
+  
+  <!-- ===================================================================== -->
+  <!-- Examples -->
+  <!-- ===================================================================== -->
+  
+  <refsection>
+    <title>Examples</title>
+    <programlisting role="example">
+<![CDATA[
+atomsRepositories()
+atomsAddRepository(["http://www.repository1.com";"http://www.repository1.com"
+atomsRepositories()
+]]>
+       </programlisting>
+  </refsection>
+  
+  <!-- ===================================================================== -->
+  <!-- See also -->
+  <!-- ===================================================================== -->
+  
+  <refsection>
+    <title>See Also</title>
+    <simplelist type="inline">
+      <member>
+        <link linkend="atomsDelRepository">atomsDelRepository</link>
+      </member>
+      <member>
+        <link linkend="atomsRepositories">atomsRepositories</link>
+      </member>
+    </simplelist>
+  </refsection>
+  
+  <!-- ===================================================================== -->
+  <!-- Authors -->
+  <!-- ===================================================================== -->
+  
+  <refsection>
+    <title>Authors</title>
+    <simplelist type="vert">
+      <member>Pierre MARECHAL - DIGITEO</member>
+    </simplelist>
+  </refsection>
+</refentry>
diff --git a/scilab/modules/atoms/help/en_US/atomsDelRepository.xml b/scilab/modules/atoms/help/en_US/atomsDelRepository.xml
new file mode 100644 (file)
index 0000000..316391c
--- /dev/null
@@ -0,0 +1,132 @@
+<?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="atomsDelRepository">
+  <info>
+       <pubdate>$LastChangedDate$</pubdate>
+  </info>
+  <refnamediv>
+    <refname>atomsDelRepository</refname>
+    <refpurpose>Remove one or several URLs from the list of managed repositories</refpurpose>
+  </refnamediv>
+  
+  <!-- ===================================================================== -->
+  <!-- Calling Sequence -->
+  <!-- ===================================================================== -->
+
+  <refsynopsisdiv>
+    <title>Calling Sequence</title>
+    <synopsis>
+         nbDel = atomsDelRepository(url[,allusers])
+       </synopsis>
+  </refsynopsisdiv>
+  
+  <!-- ===================================================================== -->
+  <!-- Parameters -->
+  <!-- ===================================================================== -->
+  
+  <refsection>
+    <title>Parameters</title>
+       
+    <variablelist>
+      <varlistentry>
+        <term>url</term>
+        <listitem>
+          <para>
+                       Matrix of strings : list of the URLs to remove
+                 </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>allusers</term>
+        <listitem>
+          <para>
+                       A boolean : if this parameter is equal to TRUE (%T), URLs are removed
+                       from "allusers" and "user" list.
+                       
+                       If allusers is set to TRUE (%T) and the directory SCI/.atoms/ is not
+                       write accessible, atomsDelRepository will produce an error.
+                       
+                       if this parameter is equal to FALSE (%T), URLs are only removed
+                       from "user" list.
+                 </para>
+        </listitem>
+      </varlistentry>
+         
+      <varlistentry>
+        <term>nbDel</term>
+        <listitem>
+          <para>
+                       An integer : the number of repositories successfully removed.
+                 </para>
+        </listitem>
+      </varlistentry>
+         
+    </variablelist>
+  </refsection>
+  
+  <!-- ===================================================================== -->
+  <!-- Description -->
+  <!-- ===================================================================== -->
+  
+  <refsection>
+    <title>Description</title>
+    <para>
+         
+       </para>
+  </refsection>
+  
+  <!-- ===================================================================== -->
+  <!-- Examples -->
+  <!-- ===================================================================== -->
+  
+  <refsection>
+    <title>Examples</title>
+    <programlisting role="example">
+<![CDATA[
+atomsRepositories()
+atomsAddRepository(["http://www.repository1.com";"http://www.repository2.com"])
+atomsRepositories()
+atomsDelRepository(["http://www.repository1.com";"http://www.repository2.com"])
+atomsRepositories()
+]]>
+       </programlisting>
+  </refsection>
+  
+  <!-- ===================================================================== -->
+  <!-- See also -->
+  <!-- ===================================================================== -->
+  
+  <refsection>
+    <title>See Also</title>
+    <simplelist type="inline">
+      <member>
+        <link linkend="atomsDelRepository">atomsAddRepository</link>
+      </member>
+      <member>
+        <link linkend="atomsRepositories">atomsRepositories</link>
+      </member>
+    </simplelist>
+  </refsection>
+  
+  <!-- ===================================================================== -->
+  <!-- Authors -->
+  <!-- ===================================================================== -->
+  
+  <refsection>
+    <title>Authors</title>
+    <simplelist type="vert">
+      <member>Pierre MARECHAL - DIGITEO</member>
+    </simplelist>
+  </refsection>
+</refentry>
diff --git a/scilab/modules/atoms/help/en_US/atomsRepositories.xml b/scilab/modules/atoms/help/en_US/atomsRepositories.xml
new file mode 100644 (file)
index 0000000..41492fd
--- /dev/null
@@ -0,0 +1,120 @@
+<?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="atomsRepositories">
+  <info>
+       <pubdate>$LastChangedDate$</pubdate>
+  </info>
+  <refnamediv>
+    <refname>atomsRepositories</refname>
+    <refpurpose>Get the list of managed repositories</refpurpose>
+  </refnamediv>
+  
+  <!-- ===================================================================== -->
+  <!-- Calling Sequence -->
+  <!-- ===================================================================== -->
+
+  <refsynopsisdiv>
+    <title>Calling Sequence</title>
+    <synopsis>
+         repositories = atomsRepositories(level)
+       </synopsis>
+  </refsynopsisdiv>
+  
+  <!-- ===================================================================== -->
+  <!-- Parameters -->
+  <!-- ===================================================================== -->
+  
+  <refsection>
+    <title>Parameters</title>
+       
+    <variablelist>
+      <varlistentry>
+        <term>level</term>
+        <listitem>
+          <para>
+                       Character string : Filter the output matrix according to repositories
+                       are officials, have been added for all users or have been added for the
+                       current user.
+                 </para>
+        </listitem>
+      </varlistentry>
+         
+      <varlistentry>
+        <term>repositories</term>
+        <listitem>
+          <para>
+                       Matrix of strings : the first column give the list of repositories
+                       managed by ATOMS and the second column indicate if the repository is
+                       a official repository, if the repository has been added for all users
+                       or only for the current user.
+                 </para>
+        </listitem>
+      </varlistentry>
+         
+    </variablelist>
+  </refsection>
+  
+  <!-- ===================================================================== -->
+  <!-- Description -->
+  <!-- ===================================================================== -->
+  
+  <refsection>
+    <title>Description</title>
+    <para>
+         
+       </para>
+  </refsection>
+  
+  <!-- ===================================================================== -->
+  <!-- Examples -->
+  <!-- ===================================================================== -->
+  
+  <refsection>
+    <title>Examples</title>
+    <programlisting role="example">
+<![CDATA[
+atomsRepositories()
+atomsRepositories('official')
+atomsRepositories('allusers')
+atomsRepositories('user')
+]]>
+       </programlisting>
+  </refsection>
+  
+  <!-- ===================================================================== -->
+  <!-- See also -->
+  <!-- ===================================================================== -->
+  
+  <refsection>
+    <title>See Also</title>
+    <simplelist type="inline">
+      <member>
+        <link linkend="atomsRepositories">atomsAddRepository</link>
+      </member>
+      <member>
+        <link linkend="atomsRepositories">atomsDelRepository</link>
+      </member>
+    </simplelist>
+  </refsection>
+  
+  <!-- ===================================================================== -->
+  <!-- Authors -->
+  <!-- ===================================================================== -->
+  
+  <refsection>
+    <title>Authors</title>
+    <simplelist type="vert">
+      <member>Pierre MARECHAL - DIGITEO</member>
+    </simplelist>
+  </refsection>
+</refentry>
index fc50901..91bc060 100644 (file)
@@ -1,10 +1,12 @@
-// ====================================================================
-// help atoms module
-// Add chapter
-// Copyright INRIA 2008
-// Delphine Gasc
-// ====================================================================
-path = SCI+'/modules/atoms/help/'+getdefaultlanguage();
+// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+// Copyright (C) 2009 - 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
+
+path = SCI+"/modules/atoms/help/"+getdefaultlanguage();
 add_help_chapter("Atoms",path,%T);
 clear path add_help_chapter;
-// ====================================================================