Update parameters vocabulary
Pierre Marechal [Fri, 23 May 2008 14:41:58 +0000 (14:41 +0000)]
32 files changed:
scilab/modules/string/help/en_US/ascii.xml
scilab/modules/string/help/en_US/blanks.xml
scilab/modules/string/help/en_US/code2str.xml
scilab/modules/string/help/en_US/convstr.xml
scilab/modules/string/help/en_US/emptystr.xml
scilab/modules/string/help/en_US/grep.xml
scilab/modules/string/help/en_US/isalphanum.xml
scilab/modules/string/help/en_US/isascii.xml
scilab/modules/string/help/en_US/isdigit.xml
scilab/modules/string/help/en_US/isletter.xml
scilab/modules/string/help/en_US/isnum.xml
scilab/modules/string/help/en_US/justify.xml
scilab/modules/string/help/en_US/part.xml
scilab/modules/string/help/en_US/str2code.xml
scilab/modules/string/help/en_US/strchr.xml
scilab/modules/string/help/en_US/strcmp.xml
scilab/modules/string/help/en_US/strcmpi.xml
scilab/modules/string/help/en_US/strcspn.xml
scilab/modules/string/help/en_US/strindex.xml
scilab/modules/string/help/en_US/strings.xml
scilab/modules/string/help/en_US/stripblanks.xml
scilab/modules/string/help/en_US/strncpy.xml
scilab/modules/string/help/en_US/strrchr.xml
scilab/modules/string/help/en_US/strrev.xml
scilab/modules/string/help/en_US/strsplit.xml
scilab/modules/string/help/en_US/strspn.xml
scilab/modules/string/help/en_US/strstr.xml
scilab/modules/string/help/en_US/strsubst.xml
scilab/modules/string/help/en_US/strtod.xml
scilab/modules/string/help/en_US/strtok.xml
scilab/modules/string/help/en_US/tokenpos.xml
scilab/modules/string/help/en_US/tokens.xml

index aa68b0d..a321c86 100644 (file)
@@ -29,13 +29,13 @@ txt=ascii(a)</synopsis>
       <varlistentry>
         <term>txt</term>
         <listitem>
-          <para>character string or matrix of strings.</para>
+          <para>A character string or a matrix of character strings.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>a</term>
         <listitem>
-          <para>vector of integer ascii codes</para>
+          <para>A vector of integer ascii codes</para>
         </listitem>
       </varlistentry>
     </variablelist>
index 99dad8d..7cc1198 100644 (file)
@@ -28,7 +28,7 @@
       <varlistentry>
         <term>txt</term>
         <listitem>
-          <para>string</para>
+          <para>A single character string</para>
         </listitem>
       </varlistentry>
       <varlistentry>
index 147098a..6a7751a 100644 (file)
@@ -28,7 +28,7 @@
       <varlistentry>
         <term>str</term>
         <listitem>
-          <para>a character string</para>
+          <para>A character string</para>
         </listitem>
       </varlistentry>
       <varlistentry>
index ff31b87..2ba4a4e 100644 (file)
@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
- * Copyright (C) INRIA - 
- * 
+ * Copyright (C) INRIA
+ *
  * 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    
+ * are also available at
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
   </refnamediv>
   <refsynopsisdiv>
     <title>Calling Sequence</title>
-    <synopsis>[y]=convstr(str-matrix, ["flag"])</synopsis>
+    <synopsis>[y]=convstr(str, [flag])</synopsis>
   </refsynopsisdiv>
   <refsection>
     <title>Parameters</title>
     <variablelist>
       <varlistentry>
-        <term>str-matrix, y</term>
+        <term>str, y</term>
         <listitem>
-          <para>matrices of strings</para>
+          <para>A matrix of character strings</para>
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term>"flag"  </term>
-        <listitem>
-          <para>string (<literal>"u"</literal> for upper or <literal>"l"</literal> for lower (default value))</para>
+        <term>flag</term>
+               <listitem>
+                       <para>A character option with possible values</para>
+                       <variablelist>
+                               <varlistentry>
+                                       <term>'u'</term>
+                                       <listitem>
+                                               <para>for upper</para>
+                                       </listitem>
+                               </varlistentry>
+                               <varlistentry>
+                                       <term>'l'</term>
+                                       <listitem>
+                                               <para>for lower</para>
+                                       </listitem>
+                               </varlistentry>
+                       </variablelist>
         </listitem>
       </varlistentry>
     </variablelist>
index 828a835..45110cb 100644 (file)
@@ -30,19 +30,19 @@ s=emptystr(m,n)</synopsis>
       <varlistentry>
         <term>a</term>
         <listitem>
-          <para>any type of matrix</para>
+          <para>Any type of matrix</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>s</term>
         <listitem>
-          <para>character string matrix</para>
+          <para>A matrix of character strings</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>m,n</term>
         <listitem>
-          <para>integers</para>
+          <para>Integers</para>
         </listitem>
       </varlistentry>
     </variablelist>
index 5dbf15b..25a80af 100644 (file)
@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
- * Copyright (C) INRIA - 
- * 
+ * Copyright (C) INRIA
+ *
  * 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    
+ * are also available at
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
@@ -23,8 +23,8 @@
     <title>Calling Sequence</title>
     <synopsis>row=grep(haystack,needle )
 [row,which]=grep(haystack,needle )
-row=grep(haystack,needle ,["flag"])
-[row,which]=grep(haystack,needle ,["flag"])</synopsis>
+row=grep(haystack,needle ,[flag])
+[row,which]=grep(haystack,needle ,[flag])</synopsis>
   </refsynopsisdiv>
   <refsection>
     <title>Parameters</title>
@@ -32,14 +32,14 @@ row=grep(haystack,needle ,["flag"])
       <varlistentry>
         <term>haystack</term>
         <listitem>
-          <para>a vector of strings.</para>
+          <para>A Row vector of character strings.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>needle </term>
         <listitem>
-          <para>a character string or character string vector . The string(s)
-          to search in <literal>haystack</literal></para>
+          <para>A character string or a row vector of character strings . The string(s)
+          to search in <literal>haystack.</literal></para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -57,9 +57,9 @@ row=grep(haystack,needle ,["flag"])
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term>"Flag"</term>
+        <term>flag</term>
         <listitem>
-          <para>:string("r" for regular expression)</para>
+          <para>Character ("r" for regular expression)</para>
         </listitem>
       </varlistentry>
     </variablelist>
index 45f5e4f..f975d44 100644 (file)
       <varlistentry>
         <term>str</term>
         <listitem>
-          <para>a string</para>
+          <para>A character string.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>res</term>
         <listitem>
-          <para>boolean matrix.</para>
+          <para>A boolean matrix.</para>
         </listitem>
       </varlistentry>
     </variablelist>
index b3c95f4..6056556 100644 (file)
       <varlistentry>
         <term>str</term>
         <listitem>
-          <para>a string</para>
+          <para>A character string.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>res</term>
         <listitem>
-          <para>boolean matrix.</para>
+          <para>A Boolean matrix.</para>
         </listitem>
       </varlistentry>
     </variablelist>
index 032bdcb..32efcfd 100644 (file)
       <varlistentry>
         <term>str</term>
         <listitem>
-          <para>a string</para>
+          <para>A character string.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>res</term>
         <listitem>
-          <para>boolean matrix.</para>
+          <para>A boolean matrix.</para>
         </listitem>
       </varlistentry>
     </variablelist>
index 3395f06..4b3abf3 100644 (file)
       <varlistentry>
         <term>str</term>
         <listitem>
-          <para>a string</para>
+          <para>A character string.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>res</term>
         <listitem>
-          <para>boolean matrix.</para>
+          <para>A boolean matrix.</para>
         </listitem>
       </varlistentry>
     </variablelist>
index 1dddd3d..b47ee1b 100644 (file)
       <varlistentry>
         <term>str</term>
         <listitem>
-          <para>string matrix</para>
+          <para>A character string or a matrix of character strings.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>res</term>
         <listitem>
-          <para>boolean matrix.</para>
+          <para>A boolean matrix.</para>
         </listitem>
       </varlistentry>
     </variablelist>
index d671320..4e9bee4 100644 (file)
       <varlistentry>
         <term>T</term>
         <listitem>
-          <para>a matrix of character string.</para>
+          <para>A matrix of character string.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>Tj</term>
         <listitem>
-          <para>a matrix of character string. the justified result</para>
+          <para>A matrix of character string. the justified result</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>opt</term>
         <listitem>
-          <para>a character string option with possible values</para>
+          <para>A character option with possible values</para>
           <variablelist>
             <varlistentry>
               <term>'r'  </term>
index 72dd0e6..99cf936 100644 (file)
       <varlistentry>
         <term>mp,c</term>
         <listitem>
-          <para>string matrices</para>
+          <para>Matrix of character strings.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>v</term>
         <listitem>
-          <para>integer vector.</para>
+          <para>Integer row vector.</para>
         </listitem>
       </varlistentry>
     </variablelist>
index ff41258..d9ca930 100644 (file)
       <varlistentry>
         <term>str</term>
         <listitem>
-          <para>a character string</para>
+          <para>A character string.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>c</term>
         <listitem>
-          <para>vector of character integer codes</para>
+          <para>A vector of character integer codes</para>
         </listitem>
       </varlistentry>
     </variablelist>
index abac10e..12164b2 100644 (file)
@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
- * Copyright (C) INRIA - 
- * 
+ * Copyright (C) INRIA
+ *
  * 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    
+ * are also available at
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
@@ -29,7 +29,7 @@
       <varlistentry>
         <term>haystack</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -41,7 +41,7 @@
       <varlistentry>
         <term>res</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
     </variablelist>
index 4f25db8..ffd8baf 100644 (file)
       <varlistentry>
         <term>string_one</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>string_two</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
       <varlistentry>
index 14d03dc..29ec54c 100644 (file)
       <varlistentry>
         <term>string_one</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>string_two</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
       <varlistentry>
index f3256b8..4dc37d0 100644 (file)
       <varlistentry>
         <term>string_one</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>string_two</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
       <varlistentry>
index 3d0ad4b..cf510c9 100644 (file)
       <varlistentry>
         <term>haystack</term>
         <listitem>
-          <para>a character string. The string where to search occurrences of
+          <para>A character string. The string where to search occurrences of
           <literal>needle </literal></para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>needle </term>
         <listitem>
-          <para>a character string or character string vector . The string(s)
+          <para>A character string or character string vector . The string(s)
           to search in <literal>haystack</literal></para>
         </listitem>
       </varlistentry>
index 2dd325b..bda3da5 100644 (file)
   <refsection>
     <title>Examples</title>
     <programlisting role="example"><![CDATA[
-
 ['this','is'; 'a 2x2','matrix']
 "matrix"=="mat"+"rix"
   ]]></programlisting>
   </refsection>
   <refsection>
index 55858aa..c9cecdd 100644 (file)
@@ -29,7 +29,7 @@
       <varlistentry>
         <term>txt</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
       <varlistentry>
index fd8b8f4..4ba07c5 100644 (file)
@@ -28,7 +28,7 @@
       <varlistentry>
         <term>str1</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -40,7 +40,7 @@
       <varlistentry>
         <term>res</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
     </variablelist>
index c997fb4..7b964ce 100644 (file)
@@ -28,7 +28,7 @@
       <varlistentry>
         <term>str1</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -40,7 +40,7 @@
       <varlistentry>
         <term>res</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
     </variablelist>
index 8c360ed..848203c 100644 (file)
       <varlistentry>
         <term>str1</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>res</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
     </variablelist>
index 950df67..5df970b 100644 (file)
@@ -28,8 +28,7 @@
       <varlistentry>
         <term>str</term>
         <listitem>
-          <para>a string
-       </para>
+          <para>A character string</para>
         </listitem>
       </varlistentry>
       <varlistentry>
index a0c3b63..7b47db1 100644 (file)
       <varlistentry>
         <term>str1</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>str2</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
       <varlistentry>
index e5a864c..8867ab8 100644 (file)
       <varlistentry>
         <term>haystack</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>needle</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>res</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
     </variablelist>
index 323af35..7a91073 100644 (file)
@@ -37,20 +37,19 @@ str=strsubst(string,searchStr,replaceStr,[flag])</synopsis>
       <varlistentry>
         <term>searchStr</term>
         <listitem>
-          <para>a character string. The string to search in
-          <literal>string</literal>.</para>
+          <para>A character string. The string to search in <literal>string</literal>.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>replaceStr</term>
         <listitem>
-          <para>a character string. The replacement string.</para>
+          <para>A character string. The replacement string.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>str</term>
         <listitem>
-          <para>a matrix of character string. The result of the substitution
+          <para>A matrix of character strings. The result of the substitution
           on <literal>searchStr</literal> by <literal>replaceStr</literal> in <literal>string</literal></para>
         </listitem>
       </varlistentry>
index 6a09da3..89f980f 100644 (file)
       <varlistentry>
         <term>str</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>d</term>
         <listitem>
-          <para>real or matrix of reals</para>
+          <para>A real or matrix of reals</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>endstr</term>
         <listitem>
-          <para>string or matrix of strings</para>
+          <para>A character string or matrix of character strings</para>
         </listitem>
       </varlistentry>
     </variablelist>
index 1b50fcb..52e52d1 100644 (file)
       <varlistentry>
         <term>str</term>
         <listitem>
-          <para>a string</para>
+          <para>A character string</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>delimiters</term>
         <listitem>
-          <para>a string</para>
+          <para>A character string</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>res</term>
         <listitem>
-          <para>string</para>
+          <para>A character string</para>
         </listitem>
       </varlistentry>
     </variablelist>
index ae70c81..32c1234 100644 (file)
       <varlistentry>
         <term>str</term>
         <listitem>
-          <para>a character string. The string where to search the tokens.</para>
+          <para>A character string. The string where to search the tokens.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>delimiter</term>
         <listitem>
-          <para>(optional) a character or a vector of characters. The tokens delimeters.</para>
+          <para>(optional) A character or a vector of characters. The tokens delimeters.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         <term>kdf</term>
         <listitem>
-          <para>two columns matrix, first column gives the index of the beginning of the tokens, the second gives the index of the last character of the tokens.</para>
+          <para>Two columns matrix, first column gives the index of the beginning of the tokens, the second gives the index of the last character of the tokens.</para>
         </listitem>
       </varlistentry>
     </variablelist>
index 316ecb1..1fea715 100644 (file)
@@ -28,7 +28,7 @@
       <varlistentry>
         <term>str</term>
         <listitem>
-          <para>a character string. The string where to search the tokens.</para>
+          <para>A character string. The string where to search the tokens.</para>
         </listitem>
       </varlistentry>
       <varlistentry>