ATOMS: atomsRepositoryXXX: Better management of "allusers"/"user" sections
[scilab.git] / scilab / modules / atoms / help / en_US / atomsRepositoryList.xml
index d624feb..944fe5a 100644 (file)
@@ -21,8 +21,7 @@
   <refsynopsisdiv>
     <title>Calling Sequence</title>
     <synopsis>
-                       repositories = atomsRepositoryList()
-                       repositories = atomsRepositoryList(level)
+                       repositories = atomsRepositoryList([section])
                </synopsis>
   </refsynopsisdiv>
   <!-- ===================================================================== -->
   <refsection>
     <title>Parameters</title>
     <variablelist>
-      <varlistentry>
-        <term>level</term>
+                       <varlistentry>
+        <term>section</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.
+                                               This argument controls the list of section where search URL(s).
+                                       </para>
+          <para>
+                                               <literal>section</literal> is a single-string and its value should be :
+                                       </para>
+          <itemizedlist>
+            <listitem>
+              <para>
+                                                               <literal>"all"</literal>: URL(s) present in the "user", "allusers"
+                                                               and "official" section are listed.
+                                                       </para>
+            </listitem>
+            <listitem>
+              <para>
+                                                               <literal>"allusers"</literal>: only URL(s) present in the "allusers"
+                                                               section are listed.
+                                                       </para>
+            </listitem>
+            <listitem>
+              <para>
+                                                               <literal>"user"</literal>: only URL(s) present in the "user"
+                                                               section are listed.
+                                                       </para>
+            </listitem>
+            <listitem>
+              <para>
+                                                               <literal>"official"</literal>: only URL(s) present in the "official"
+                                                               section are listed.
+                                                       </para>
+            </listitem>
+          </itemizedlist>
+                                       <para>
+                                               The default value is "all".
                                        </para>
         </listitem>
-      </varlistentry>
+                       </varlistentry>
       <varlistentry>
         <term>repositories</term>
         <listitem>
   <!-- ===================================================================== -->
   <refsection>
     <title>Examples</title>
-    <programlisting role="example"><![CDATA[ 
+    <programlisting role="example"><![CDATA[
+atomsRepositoryAdd('http://scene1.atoms.scilab.org');
 atomsRepositoryList()
+atomsRepositoryList('all')
 atomsRepositoryList('official')
 atomsRepositoryList('allusers')
 atomsRepositoryList('user')
+atomsRepositoryDel('http://scene1.atoms.scilab.org');
  ]]></programlisting>
   </refsection>
   <!-- ===================================================================== -->