Revision of help pages of module "string" (en_US). 65/9665/1
Stanislav KROTER [Tue, 13 Nov 2012 07:47:01 +0000 (13:47 +0600)]
Change-Id: I24d0322ec0571505e5cf1de9b6a75b723f1a8907

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/char.xml
scilab/modules/string/help/en_US/convstr.xml
scilab/modules/string/help/en_US/eval.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/isletter.xml
scilab/modules/string/help/en_US/isnum.xml
scilab/modules/string/help/en_US/justify.xml
scilab/modules/string/help/en_US/length.xml
scilab/modules/string/help/en_US/part.xml
scilab/modules/string/help/en_US/sci2exp.xml
scilab/modules/string/help/en_US/strcat.xml
scilab/modules/string/help/en_US/strchr.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/string.xml
scilab/modules/string/help/en_US/strings.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 91353d2..7d1feae 100644 (file)
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="ascii" xml:lang="en">
     <refnamediv>
         <refname>ascii</refname>
-        <refpurpose>string ascii conversions</refpurpose>
+        <refpurpose>string ASCII conversions</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>a=ascii(txt)
-            txt=ascii(a)
+        <synopsis>a = ascii(txt)
+            txt = ascii(a)
         </synopsis>
     </refsynopsisdiv>
     <refsection>
             <varlistentry>
                 <term>txt</term>
                 <listitem>
-                    <para>A character string or a matrix of character strings.</para>
+                    <para>a character string or a matrix of character strings.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>a</term>
                 <listitem>
-                    <para>A vector of integer ascii codes</para>
+                    <para>a vector of integer ASCII codes</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     </refsection>
     <refsection>
         <title>Description</title>
-        <para>This function convert Scilab string to a vector of ascii code (the first 127 codes are ASCII) or
-            vector of ascii code to Scilab strings.
+        <para>
+            This function converts Scilab string to a vector of ASCII code (the first 127
+            codes are ASCII) or vector of ASCII code to Scilab strings.
         </para>
         <para>
-            If <literal>txt</literal> is a matrix of string,
-            <literal>ascii(txt)</literal> is equivalent to
-            <literal>ascii(strcat(txt))</literal>
+            If <varname>txt</varname> is a matrix of string, <code>ascii(txt)</code> is
+            equivalent to <code>ascii(strcat(txt))</code>.
         </para>
     </refsection>
     <refsection>
index 35e773d..e2c2b75 100644 (file)
 <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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="blanks">
     <refnamediv>
         <refname>blanks</refname>
-        <refpurpose>Create string of blank characters</refpurpose>
+        <refpurpose>create string of blank characters</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>txt=blanks(n)</synopsis>
+        <synopsis>txt = blanks(n)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
             <varlistentry>
                 <term>txt</term>
                 <listitem>
-                    <para>A single character string</para>
+                    <para>a single character string.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>n</term>
                 <listitem>
-                    <para>number of blanks</para>
+                    <para>an integer, number of blanks.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     </refsection>
     <refsection>
         <title>Description</title>
-        <para>blanks(n) is a string of n blanks.</para>
+        <para>
+            <code>blanks(n)</code> is a string of <varname>n</varname> blanks.
+        </para>
     </refsection>
     <refsection>
         <title>Examples</title>
index 78294d7..fdb189c 100644 (file)
@@ -17,8 +17,9 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>y=char(x)
-            y=char(st1,st2,st3,...)
+        <synopsis>
+            y = char(x)
+            y = char(st1, st2, st3,...)
         </synopsis>
     </refsynopsisdiv>
     <refsection>
             <varlistentry>
                 <term>x</term>
                 <listitem>
-                    <para>a cell array of strings, or an array of ascii codes</para>
+                    <para>a cell array of strings, or an array of ASCII codes.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>st1,st2,st3</term>
+                <term>st1, st2, st3</term>
                 <listitem>
-                    <para>arrays of strings</para>
+                    <para>arrays of strings.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>y</term>
                 <listitem>
-                    <para>a vector of strings (column)</para>
+                    <para>a vector of strings (column).</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>One input argument :</literal>
+            <emphasize role="bold">One input argument :</emphasize>
         </para>
         <para>
-            Given a cell of  array of strings <literal>x</literal>, this function
-            returns a vector of strings <literal>y</literal> in which the rows are the 
+            Given a cell of array of strings <varname>x</varname>, this function
+            returns a vector of strings <varname>y</varname> in which the rows are the
             concatenated components of corresponding rows of the cell array of strings.
         </para>
         <para>
-            Given an array of ascii codes <literal>x</literal>, this function
-            returns a  array of strings <literal>y</literal> corresponding into ascii
-            codes. If dimensions of <literal>x</literal> are <literal>[n1,n2,n3,n4,...]</literal>, 
+            Given an array of ASCII codes <varname>x</varname>, this function
+            returns a  array of strings <varname>y</varname> corresponding into ASCII
+            codes. If dimensions of <varname>x</varname> are <literal>[n1, n2, n3, n4,...]</literal>,
             then returned value has same size as input value except second dimension, i.e.
-            the dimensions of <literal>y</literal> are <literal>[n1,n3,n4,...]</literal>.
+            the dimensions of <varname>y</varname> are <literal>[n1, n3, n4,...]</literal>.
         </para>
         <para>
-            <literal>More than one input argument :</literal>
+            <emphasize role="bold">More than one input argument :</emphasize>
         </para>
         <para>
-            Given arrays of strings <literal>st1,st2,st3,...</literal>, this function 
+            Given arrays of strings <literal>st1, st2, st3,...</literal>, this function 
             returns a vector of strings in which the rows are the concatenated 
-            components of corresponding rows of <literal>st1,st2,st3,...</literal>. 
-            In the vector <literal>y</literal> all strings <literal>sti</literal> 
+            components of corresponding rows of <literal>st1, st2, st3,...</literal>.
+            In the vector <varname>y</varname> all strings <literal>sti</literal>
             are completed by blanks to have the same length as the max length of 
             <literal>sti</literal>.
         </para>
@@ -76,7 +77,7 @@
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[ 
-//Example with a hypermatrix of ascii codes :
+//Example with a hypermatrix of ASCII codes :
 x=hypermat([4,2,3],61:84);
 y=char(x)
 size(x)
index 52aa233..fd212ab 100644 (file)
@@ -17,7 +17,7 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>[y]=convstr(str, [flag])</synopsis>
+        <synopsis>[y] = convstr(str, [flag])</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
             <varlistentry>
                 <term>str, y</term>
                 <listitem>
-                    <para>A matrix of character strings</para>
+                    <para>a matrix of character strings.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>flag</term>
                 <listitem>
-                    <para>A character option with possible values</para>
+                    <para>a character option with possible values:</para>
                     <variablelist>
                         <varlistentry>
                             <term>'u'</term>
                             <listitem>
-                                <para>for upper</para>
+                                <para>for upper;</para>
                             </listitem>
                         </varlistentry>
                         <varlistentry>
                             <term>'l'</term>
                             <listitem>
-                                <para>for lower</para>
+                                <para>for lower.</para>
                             </listitem>
                         </varlistentry>
                     </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            converts the matrix of strings <literal>str-matrix</literal>
-            into lower case (for <literal>"l"</literal> ;default value) or
-            upper case (for <literal>"u"</literal>).
+            The <function>convstr</function> function converts the matrix of strings
+            <varname>str</varname> into lower case (for <varname>flag</varname> =
+            <literal>"l"</literal>; default value) or upper case (for
+            <varname>flag</varname> = <literal>"u"</literal>).
         </para>
     </refsection>
     <refsection>
index 3e17d9a..ba4b814 100644 (file)
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>[H]= eval(Z)</synopsis>
+        <synopsis>[H] = eval(Z)</synopsis>
     </refsynopsisdiv>
     <refsection>
+        <title>Arguments</title>
+        <variablelist>
+            <varlistentry>
+                <term>Z</term>
+                <listitem>
+                    <para>a matrix of character string.</para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsection>
+    <refsection>
         <title>Description</title>
-        <para>returns the evaluation of the matrix of character strings
-            <literal>Z</literal>.
+        <para>
+            The <function>eval</function> function returns the evaluation of the matrix of character strings
+            <varname>Z</varname>.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[ 
-a=1; b=2; Z=['a','sin(b)'] ; eval(Z)  //returns the matrix [1,0.909];
+a=1;
+b=2;
+Z=['a','sin(b)'];
+eval(Z)  //returns the matrix [1, 0.909];
  ]]></programlisting>
     </refsection>
     <refsection role="see also">
index 5a45269..d82354f 100644 (file)
     </refnamediv>
     <refsynopsisdiv>
         <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 )
+            [row, which] = grep(haystack, needle )
+            row = grep(haystack, needle, [flag])
+            [row, which] = grep(haystack, needle, [flag])
         </synopsis>
     </refsynopsisdiv>
     <refsection>
             <varlistentry>
                 <term>haystack</term>
                 <listitem>
-                    <para>A Row vector of character strings.</para>
+                    <para>a row vector of character strings.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>needle</term>
                 <listitem>
-                    <para>A character string or a row vector of character strings . The
-                        string(s) to search in <literal>haystack.</literal>
+                    <para>
+                        a character string or a row vector of character strings. The
+                        string(s) to search in <varname>haystack</varname>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>row</term>
                 <listitem>
-                    <para>vector of indices: row where a match has been found or an
+                    <para>
+                        a vector of indices: row where a match has been found or an
                         empty matrix if no match found.
                     </para>
                 </listitem>
             <varlistentry>
                 <term>which</term>
                 <listitem>
-                    <para>vector of indices: index of needle string found or an empty
-                        matrix if no match found.
+                    <para>
+                        a vector of indices: index of <varname>needle</varname> string found
+                        or an empty matrix if no match found.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>flag</term>
                 <listitem>
-                    <para>Character ("r" for regular expression)</para>
+                    <para>a character (<literal>"r"</literal> for regular expression)</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            Foreach entry of <literal>haystack </literal>, grep searches if at
-            least a string in <literal>needle</literal> which matches a substring.
-            The <literal>haystack</literal> entries index where at least a match has
-            been found are returned in the <literal>row</literal> output argument.
-            The optional <literal>which</literal> output argument gives the index
-            of first string of <literal>needle</literal> found.
+            For each entry of <varname>haystack</varname>, <function>grep</function>
+            searches if at least a string in <varname>needle</varname> which matches a
+            substring. The <varname>haystack</varname> entries index where at least a
+            match has been found are returned in the <varname>row</varname> output
+            argument. The optional <varname>which</varname> output argument gives the
+            index of first string of <varname>needle</varname> found.
         </para>
         <para>
-            When using the third parameter <literal>flag="r"</literal>, the
-            <literal>needle</literal> is expected to be a regular expression string.
-            In this case, <literal>grep</literal> uses the
-            <literal>needle</literal> as a regular expression and compares it
-            against <literal>haystack</literal> according to the regular express
+            When using the third parameter <varname>flag<varname><literal>="r"</literal>, the
+            <varname>needle</varname> is expected to be a regular expression string.
+            In this case, <function>grep</function> uses the
+            <varname>needle</varname> as a regular expression and compares it
+            against <varname>haystack</varname> according to the regular expressions
             rules. See the <link linkend="regexp">regexp</link> function for details about
             regular expressions.
         </para>
     </refsection>
     <refsection>
         <title>Example #1</title>
-        <para>In the following example, we search one or two strings in a text,
-            which is stored in the <literal>txt</literal> variable.
+        <para>
+            In the following example, we search one or two strings in a text,
+            which is stored in the <varname>txt</varname> variable.
         </para>
         <programlisting role="example"><![CDATA[ 
 txt=['find matches of a string in a vector of strings'
index 55a98c1..11d7b7a 100644 (file)
             <varlistentry>
                 <term>str</term>
                 <listitem>
-                    <para>A character string.</para>
+                    <para>a character string.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>res</term>
                 <listitem>
-                    <para>A boolean matrix.</para>
+                    <para>a boolean matrix.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>res = isalphanum(str)</literal> returns an array the same size as str containing logical %t (true) where the elements of str are alphanumerics and logical %f (false) where they are not.
+            <code>res = isalphanum(str)</code> returns an array the same size as
+            <varname>str</varname> containing logical <constant>%t</constant>
+            (true) where the elements of <varname>str</varname> are
+            alphanumerics and logical <constant>%f</constant> (false) where they
+            are not.
         </para>
     </refsection>
     <refsection>
index d53416c..e1553f4 100644 (file)
             <varlistentry>
                 <term>str</term>
                 <listitem>
-                    <para>A character string.</para>
+                    <para>a character string.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>res</term>
                 <listitem>
-                    <para>A Boolean matrix.</para>
+                    <para>a boolean matrix.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
@@ -39,9 +39,9 @@
     <refsection>
         <title>Description</title>
         <para>
-            <literal>res = isascii(str)</literal> returns TRUE (%T) if c is a 7-bit
+            <code>res = isascii(str)</code> returns <constant>%t</constant> (TRUE) if <varname>str</varname> is a 7-bit
             US-ASCII character code between 0 and octal 0177 inclusive.
-            otherwise returns FALSE (%F)
+            Otherwise returns <constant>%f</constant> (FALSE).
         </para>
     </refsection>
     <refsection>
index e01da43..80612e2 100644 (file)
@@ -1,19 +1,26 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
- * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
- * 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    
- * 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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="isletter">
+* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+* 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
+* 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"
+xml:lang="en" xml:id="isletter">
     <refnamediv>
         <refname>isletter</refname>
-        <refpurpose>check that characters of a string are alphabetics letters</refpurpose>
+        <refpurpose>
+            check that characters of a string are alphabetic letters
+        </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
             <varlistentry>
                 <term>str</term>
                 <listitem>
-                    <para>A character string.</para>
+                    <para>a character string.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>res</term>
                 <listitem>
-                    <para>A boolean matrix.</para>
+                    <para>a boolean matrix.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>res = isletter(str)</literal> returns an array the same size as str
-            containing logical %t (true) where the elements of str are letters of
-            the alphabet and logical %f (false) where they are not.
+            <code>res = isletter(str)</code> returns an array the same size as
+            <varname>str</varname> containing logical <constant>%t</constant>
+            (true) where the elements of <varname>str</varname> are letters of
+            the alphabet and logical <constant>%f</constant> (false) where they
+            are not.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 s = 'A1,B2,C3';
 isletter(s)
- ]]></programlisting>
+        ]]></programlisting>
     </refsection>
     <refsection role="see also">
         <title>See Also</title>
index 101258d..e4d3ce0 100644 (file)
@@ -1,16 +1,21 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
- * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
- * 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    
- * 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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="isnum">
+* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+* 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
+* 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"
+xml:lang="en" xml:id="isnum">
     <refnamediv>
         <refname>isnum</refname>
         <refpurpose>tests if a string represents a number</refpurpose>
             <varlistentry>
                 <term>str</term>
                 <listitem>
-                    <para>A character string or a matrix of character strings.</para>
+                <para>
+                    a character string or a matrix of character strings.
+                </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>res</term>
                 <listitem>
-                    <para>A boolean matrix.</para>
+                    <para>a boolean matrix.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>res = isnum(str)</literal>returns %T if str represents a number
+            <code>res = isnum(str)</code>returns <constant>%t</constant> if
+            <varname>str</varname> represents a number.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 isnum(['1'     , ..
-       '-1.23' , ..
-       '+1e+23', .. 
-       '1d+23' , ..
-       '%pi'])
- ]]></programlisting>
+    '-1.23' , ..
+    '+1e+23', ..
+    '1d+23' , ..
+    'A'     , ..
+    '%pi'])
+    ]]></programlisting>
     </refsection>
     <refsection role="see also">
         <title>See Also</title>
index cbe55a0..6b8b680 100644 (file)
@@ -1,23 +1,28 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
- * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
- * 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    
- * 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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="justify">
+* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+* 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
+* 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"
+        xml:lang="en" xml:id="justify">
     <refnamediv>
         <refname>justify</refname>
-        <refpurpose>Justify character array.  </refpurpose>
+        <refpurpose>justify character array</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>Tj=justify(T,opt)</synopsis>
+        <synopsis>Tj = justify(T, opt)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
             <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>
-                </listitem>
+                <para>
+                    a matrix of character string. the justified result.
+                </para>
+            </listitem>
             </varlistentry>
             <varlistentry>
                 <term>opt</term>
                 <listitem>
-                    <para>A character option with possible values</para>
+                    <para>
+                        a character option with possible values:
+                    </para>
                     <variablelist>
                         <varlistentry>
-                            <term>'r'  </term>
+                            <term>'r'or 'right'</term>
                             <listitem>
-                                <para>or 'right' for right justification</para>
+                                <para>for right justification;</para>
                             </listitem>
                         </varlistentry>
                         <varlistentry>
-                            <term>'l'  </term>
+                            <term>'l' or 'left'</term>
                             <listitem>
-                                <para>or 'left' for left justification</para>
+                                <para>for left justification;</para>
                             </listitem>
                         </varlistentry>
                         <varlistentry>
-                            <term>'c'  </term>
+                            <term>'c' or 'center'</term>
                             <listitem>
-                                <para>or 'center' for centering justification</para>
+                                <para>for centering justification.</para>
                             </listitem>
                         </varlistentry>
                     </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>justify</literal> justify the column of a matrix of string accdording to
-            the given option.
+            The <function>justify</function> function justifies the column of a
+                matrix of string according to the given option <varname>opt</varname>.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 t=['1234','x','adfdfgdfghfgj'
    '1','354556','dgf'
    'sdfgd','','sdfsf'];
@@ -79,7 +88,7 @@ t=['1234','x','adfdfgdfghfgj'
 justify(t,'l')
 justify(t,'c')
 justify(t,'r')
- ]]></programlisting>
+    ]]></programlisting>
     </refsection>
     <refsection role="see also">
         <title>See Also</title>
@@ -93,3 +102,4 @@ justify(t,'r')
         </simplelist>
     </refsection>
 </refentry>
+                                    
\ No newline at end of file
index fce96bf..f8520b3 100644 (file)
  * 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:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="length" xml:lang="en">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xml:id="length" xml:lang="en">
     <refnamediv>
         <refname>length</refname>
         <refpurpose>length of object</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>n=length(M)</synopsis>
+        <synopsis>n = length(M)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
             <varlistentry>
                 <term>M</term>
                 <listitem>
-                    <para>matrix (usual or polynomial or character string) or
-                        list
+                    <para>
+                        a matrix (usual or polynomial or character string) or a
+                        list.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>n</term>
                 <listitem>
-                    <para>integer or integer matrix</para>
+                    <para>an integer or a matrix of integers.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            For usual or polynomial matrix <literal>n</literal> is the integer
-            equal to number of rows times number of columns of <literal>M</literal>.
-            (Also valid for <literal>M</literal> a boolean matrix)
+            For usual or polynomial matrix <varname>n</varname> is the integer
+            equal to number of rows times number of columns
+            of <varname>M</varname>. (Also valid for <varname>M</varname>
+            a boolean matrix).
         </para>
-        <para>For matrices made of character strings (and in particular for a
-            character string) <literal>length</literal> returns in
-            <literal>n</literal> the length of entries of the matrix of character
-            strings <literal>M</literal>.
+        <para>
+            For matrices made of character strings (and in particular for a
+            character string) <function>length</function> returns in
+            <varname>n</varname> the length of entries of the matrix of
+            character strings <varname>M</varname>.
         </para>
-        <para>The length of a list is the number of elements in the list (also
-            given by <literal>size</literal>).
+        <para>
+            The length of a list is the number of elements in the list (also
+            given by <function>size</function>).
         </para>
-        <para>The length of a mlist is by default the number of elements in the mlist, 
-            but you can overload it (see example).
+        <para>
+            The length of a mlist is by default the number of elements in the
+            mlist, but you can overload it (see example).
         </para>
         <para>
-            <literal>length('123')</literal> is <literal>3</literal>.
-            <literal>length([1,2;3,4])</literal> is <literal>4</literal>.
+            <code>length('123')</code> is <literal>3</literal>.
+            <code>length([1,2;3,4])</code> is <literal>4</literal>.
         </para>
-        <para>WARNING : length of a sparse matrix returns the max of dimensions
-            and not the product of the dimensions. (example :
-            length(sparse(eye(12,2))) returns max(12,2) and not 24)
+        <para>
+            <warning>
+                WARNING : <function>length</function> of a sparse matrix
+                returns the max of dimensions and not the product
+                of the dimensions. (For example:
+                <code>length(sparse(eye(12,2)))</code>
+                returns <code>max(12,2)</code> and not <literal>24</literal>).
+                Please use <literal>size(...,'*')</literal> with sparse matrix.
+            </warning>
         </para>
-        <para>please use size(...,'*') with sparse matrix.</para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 length([123 ; 456 ])
 length(['hello world',SCI])
 
- ]]></programlisting>
-        <programlisting role="example"><![CDATA[  
+    ]]></programlisting>
+        <programlisting role="example"><![CDATA[
 
 a = mlist(["myMlistT" "field1" "field2"],"aexample","bexampleb");
-length(a) 
-// returns 3 default behaviour if length not overloaded for MList
+length(a)
+// returns 3 default behaviour if length not overloaded for mlist
 
-// we create an overload function for MList of type myMlistT
+// we create an overload function for mlist of type myMlistT
 function r = %myMlistT_length(M)
-  r = length(M.field1)
+    r = length(M.field1)
 endfunction
 
-length(a) 
-// returns 8 result of length(a.field1) 
-  ]]></programlisting>
+length(a)
+// returns 8 result of length(a.field1)
+    ]]></programlisting>
     </refsection>
     <refsection role="see also">
         <title>See Also</title>
@@ -101,7 +111,9 @@ length(a)
         <revhistory>
             <revision>
                 <revnumber>5.4.0</revnumber>
-                <revremark>This function allows overloading for mlist type.</revremark>
+                <revremark>
+                    This function allows overloading for mlist type.
+                </revremark>
             </revision>
         </revhistory>
     </refsection>
index 289e36a..9112eb6 100644 (file)
@@ -10,7 +10,7 @@
  * 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:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="part" xml:lang="en">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xml:id="part" xml:lang="en">
     <refnamediv>
         <refname>part</refname>
         <refpurpose>extraction of strings</refpurpose>
             <varlistentry>
                 <term>strings_in, strings_out</term>
                 <listitem>
-                    <para>Matrix of character strings.</para>
+                    <para>matrices of character strings.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>v</term>
                 <listitem>
-                    <para>Integer row vector.</para>
+                    <para>an integer row vector.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
         <title>Description</title>
         <para>
             Let <literal>s[k]</literal> stands for the <literal>k</literal>
-            character of string <literal>s</literal> ( or the white space character if
-            <literal>k &gt;length(s)</literal>).
+            character of string <literal>s</literal> (or the white space
+            character if <literal>k &gt;length(s)</literal>).
         </para>
         <para>
-            <literal>part</literal> returns <literal>strings_out</literal>, a
-            matrix of character strings, such that <literal>strings_out(i,j)</literal>
-            is the string <literal>"s[v(1)]...s[v(n)]"</literal> (
-            <literal>s=strings_in(i,j)</literal> ).
+            <function>part</function> returns <varname>strings_out</varname>, a
+            matrix of character strings, such that
+            <literal>strings_out(i,j)</literal> is the string
+            <literal>"s[v(1)]...s[v(n)]"</literal>
+            (<literal>s=strings_in(i,j)</literal>).
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 // returns characters position 8 to 11
 part("How to use ""part"" ?",8:11)
 
@@ -60,24 +61,27 @@ part("How to use ""part"" ?",8:11)
 // no characters replaced by ''
 c = part(['a','abc','abcd'],2:4)
 
-// returns character position 1 for each element and add characters position 4 to 7 of each element
+// returns character position 1 for each element and add characters position
+// 4 to 7 of each element
 c = part(['abcdefg','hijklmn','opqrstu'],[1,4:7]);
 
-// returns character 4 for each element, add characters position 1 to 7 and add character position 4 for each element
+// returns character 4 for each element, add characters position 1 to 7 and
+// add character position 4 for each element
 c = part(['abcdefg','hijklmn','opqrstu'],[4,1:7,4]);
 
-// returns character position 1,add again character position 1 and character position 2
+// returns character position 1, add again character position 1 and
+// character position 2
 c=part(['a','abc','abcd'],[1,1,2])
 
-// a a a  
+// a a a
 part(['a','abc','abcd'],[1])
 
-// aa aa aa 
+// aa aa aa
 part(['a','abc','abcd'],[1,1])
 
-// aa aab aab 
+// aa aab aab
 part(['a','abc','abcd'],[1,1,2])
- ]]></programlisting>
+    ]]></programlisting>
     </refsection>
     <refsection role="see also">
         <title>See Also</title>
@@ -86,6 +90,9 @@ part(['a','abc','abcd'],[1,1,2])
                 <link linkend="string">string</link>
             </member>
             <member>
+                <link linkend="strsplit">strsplit</link>
+            </member>
+            <member>
                 <link linkend="length">length</link>
             </member>
         </simplelist>
index 782c492..18281b6 100644 (file)
  * 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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="sci2exp">
+<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" xml:lang="en" xml:id="sci2exp">
     <refnamediv>
         <refname>sci2exp</refname>
-        <refpurpose>converts an expression to a string</refpurpose>
+        <refpurpose> converts an expression to a string</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>t=sci2exp(a [,nam] [,lmax])</synopsis>
+        <synopsis>t = sci2exp(a [,nam] [,lmax])</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
             <varlistentry>
                 <term>a</term>
                 <listitem>
-                    <para>a scilab expression, may be</para>
+                    <para>a scilab expression, may be:</para>
                     <variablelist>
                         <varlistentry>
                             <term>-    </term>
                             <listitem>
-                                <para>constant,</para>
+                                <para>a constant;</para>
                             </listitem>
                         </varlistentry>
                         <varlistentry>
                             <term>-    </term>
                             <listitem>
-                                <para>polynomial</para>
+                                <para>a polynomial;</para>
                             </listitem>
                         </varlistentry>
                         <varlistentry>
                             <term>-    </term>
                             <listitem>
-                                <para>string matrix</para>
+                                <para>a string matrix;</para>
                             </listitem>
                         </varlistentry>
                         <varlistentry>
                             <term>-    </term>
                             <listitem>
-                                <para>list</para>
+                                <para>a list;</para>
                             </listitem>
                         </varlistentry>
                         <varlistentry>
                             <term>-    </term>
                             <listitem>
-                                <para>boolean matrix</para>
+                                <para>a boolean matrix.</para>
                             </listitem>
                         </varlistentry>
                     </variablelist>
             <varlistentry>
                 <term>nam</term>
                 <listitem>
-                    <para>character string</para>
+                    <para>a character string.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>t</term>
                 <listitem>
-                    <para>vector of string, contains the expression or the affectation instruction</para>
+                    <para>
+                        a vector of strings, contains the expression or the affectation instruction.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>lmax</term>
                 <listitem>
                     <para>
-                        integer, contains the maximum line length. default value is 90, <literal>lmax=0</literal> indicate  no line length control a single string is returned
+                        an integer, contains the maximum line length. Default value is <literal>90</literal>,
+                        <literal>lmax=0</literal> indicates no line length control a single string is returned
                     </para>
                 </listitem>
             </varlistentry>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>sci2exp</literal> converts expression to an instruction string if <literal>nam</literal> is
+            <function>sci2exp</function> converts expression to an instruction string if <varname>nam</varname> is
             given or to an expression string.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 a=[1 2;3 4]
 sci2exp(a,'aa')
 sci2exp(a,'aa',0)
 sci2exp(ssrand(2,2,2))
 sci2exp(poly([1 0 3 4],'s'),'fi')
- ]]></programlisting>
+    ]]></programlisting>
     </refsection>
     <refsection role="see also">
         <title>See Also</title>
index d6d6d25..53183e1 100644 (file)
@@ -1,54 +1,59 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
- * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
- * 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    
- * 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:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="strcat" xml:lang="en">
+* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+* 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
+* 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:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xml:id="strcat" xml:lang="en">
     <refnamediv>
         <refname>strcat</refname>
-        <refpurpose>concatenate character strings</refpurpose>
+        <refpurpose>concatenates character strings</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>txt=strcat(vector_of_strings [,string_added])
-            txt=strcat(vector_of_strings [,string_added, ["flag"]])
+        <synopsis>
+        txt = strcat(strings [,string_added])
+        txt = strcat(strings [,string_added, ["flag"]])
         </synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
         <variablelist>
             <varlistentry>
-                <term>vector_of_strings</term>
+                <term>strings</term>
                 <listitem>
-                    <para>vector of strings</para>
+                    <para>a vector or matrix of strings.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>string_added</term>
                 <listitem>
-                    <para>string added, default value is the emptystr
-                        <literal>""</literal>
+                    <para>
+                        a string added, default value is the zero length character
+                        string <literal>""</literal>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>txt</term>
                 <listitem>
-                    <para>string</para>
+                    <para>a string.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>"flag"</term>
                 <listitem>
-                    <para>string ( "r" for return a row matrix, "c" for return a column
-                        matrix)
+                    <para>
+                        a character (<literal>"r"</literal> for concatenation of
+                        rows in the matrix <varname>strings</varname>,
+                        <literal>"c"</literal> for concatenations of columns in the
+                        matrix <varname>strings</varname>).
                     </para>
                 </listitem>
             </varlistentry>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>txt=strcat(vector_of_strings)</literal> concatenates
-            character strings :
-            <literal>txt=vector_of_strings(1)+...+vector_of_strings(n)</literal>
+            <code>txt = strcat(strings)</code> concatenates character strings:
+            <literal>txt = strings(1) + ... + strings(n)</literal>.
         </para>
         <para>
-            <literal>txt=strcat(vector_of_strings,string_added)</literal>
-            returns
-            <literal>txt=vector_of_strings(1)+string_added+...+string_added+vector_of_strings(n)</literal>.
+            <code>txt = strcat(strings, string_added)</code> returns
+            <literal>txt = strings(1) + string_added + ... + string_added + strings(n)</literal>.
         </para>
         <para>
-            The plus symbol does the same: <literal>"a"+"b"</literal> is the
-            same as <literal>strcat(["a","b"]).</literal>
+            The plus symbol does the same: <code>"a"+"b"</code> is the
+            same as <code>strcat(["a","b"]).</code>.
         </para>
-        <para>If size of vector_of_strings is one, it returns
-            <literal>txt=vector_of_strings(1); </literal>
+        <para>
+            If the size of <varname>strings<varname> is one, it returns
+            <code>txt = strings(1)</code>;
+        </para>
+        <para>
+            <code>strcat('A','B')</code> returns <literal>'A'</literal> and not
+            <literal>'AB'</literal> as <code>strcat(['A','B'])</code>.
         </para>
         <para>
-            <literal>strcat('A','B')</literal> returns 'A' and not 'AB' as
-            <literal>strcat(['A','B'])</literal>
+            If <varname>strings</varname> is a matrix of strings
+            <code>strcat(strings,"",'r')</code> returns a row vector of strings.
+            Entries of the row vector are result of concatenation of rows.
+            <code>strcat(strings,"",'c')</code> returns a column vector of strings.
+            Entries of the column vector are result of concatenation of columns.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 strcat(string(1:10),',')
 strcat(["a","b"])
 strcat(["a","b"],'|')
@@ -94,7 +105,10 @@ strcat(m, "r")
 strcat(m, "", "r")
 strcat(m, "", "c")
 
- ]]></programlisting>
+strcat(m, "_and_", "r")
+strcat(m, "_and_", "c")
+
+    ]]></programlisting>
     </refsection>
     <refsection role="see also">
         <title>See Also</title>
index 7e9a06b..189a34f 100644 (file)
  * 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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="strchr">
+<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" xml:lang="en" xml:id="strchr">
     <refnamediv>
         <refname>strchr</refname>
-        <refpurpose>Find the first occurrence of a character in
-            a string
+        <refpurpose>
+            find the first occurrence of a character in a string
         </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>res = strchr(haystack,char)</synopsis>
+        <synopsis>res = strchr(haystack, char)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
@@ -27,7 +27,9 @@
             <varlistentry>
                 <term>haystack</term>
                 <listitem>
-                    <para>A character string or matrix of character strings</para>
+                    <para>
+                        a character string or matrix of character strings.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
@@ -39,7 +41,9 @@
             <varlistentry>
                 <term>res</term>
                 <listitem>
-                    <para>A character string or matrix of character strings</para>
+                    <para>
+                        a character string or matrix of character strings.
+                    </para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>res = strchr(haystack,char)</literal> returns the first occurrence
-            of <literal>char</literal> in the string <literal>haystack</literal>.
+            <code>res = strchr(haystack, char)</code> returns the first
+            occurrence of character in the string <varname>haystack</varname>.
         </para>
         <para>
-            <literal>char</literal> must contain only one string or as many strings as in <literal>haystack</literal> (each one being one-character-long).
+            <varname>char</varname> must contain only one string or as many
+            strings as in <varname>haystack</varname> (each one being one-
+            character-long).
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 strchr('This is a sample string','s')
 strchr(['This is a sample string','in scilab'],'s')
 strchr(['This is a sample string','in scilab'],['s','a'])
- ]]></programlisting>
+    ]]></programlisting>
     </refsection>
     <refsection role="see also">
         <title>See Also</title>
index 26c5a72..5260366 100644 (file)
 <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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="strcmpi">
     <refnamediv>
         <refname>strcmpi</refname>
-        <refpurpose>compare character strings (case
-            independent)
+        <refpurpose>
+            compare character strings (case independent)
         </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>res = strcmpi(string_one,string_two)</synopsis>
+        <synopsis>res = strcmpi(string_one, string_two)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
             <varlistentry>
                 <term>string_one</term>
                 <listitem>
-                    <para>A character string or matrix of character strings</para>
+                    <para>
+                        a character string or matrix of character strings.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>string_two</term>
                 <listitem>
-                    <para>A character string or matrix of character strings</para>
+                    <para>
+                        a character string or matrix of character strings.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>res</term>
                 <listitem>
-                    <para>matrix.</para>
+                    <para>a matrix of integers.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>res = strcmpi(string_one,string_two)</literal> returns an integral
-            value indicating the relationship between the strings.
+            <code>res = strcmpi(string_one, string_two)</code> returns an
+            integral value indicating the relationship between the strings.
         </para>
-        <para>A value greater than zero indicates that the first character that does
-            not match has a greater value in <literal>string_one</literal> than in
-            <literal>string_two</literal>
+        <para>
+            The value is <literal>0</literal> if <varname>string_one</varname>
+            is equal to <varname>string_two</varname> (case independently) and
+            <literal>1</literal> indicates the opposite.
         </para>
-        <para>And a value less than zero indicates the opposite.</para>
     </refsection>
     <refsection>
         <title>Examples</title>
index 533acab..8cf94aa 100644 (file)
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="strcspn" xml:lang="en">
     <refnamediv>
         <refname>strcspn</refname>
-        <refpurpose>Get span until character in string</refpurpose>
+        <refpurpose>get span until character in string</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>res = strcspn(string_one,string_two)</synopsis>
+        <synopsis>res = strcspn(string_one, string_two)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
             <varlistentry>
                 <term>string_one</term>
                 <listitem>
-                    <para>A character string or matrix of character strings</para>
+                    <para>
+                        a character string or matrix of character strings.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>string_two</term>
                 <listitem>
-                    <para>A character string or matrix of character strings</para>
+                    <para>
+                        a character string or matrix of character strings.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>res</term>
                 <listitem>
-                    <para>matrix.</para>
+                    <para>a matrix.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>res = strcspn(string_one,string_two)</literal> Scans
-            string_one for the first occurrence of any of the characters that are part
-            of string_two, returning the number of characters of string_one read
+            <code>res = strcspn(string_one,string_two)</code> scans
+            <varname>string_one</varname> for the first occurrence of any of the
+            characters that are part of <varname>string_two</varname>, returning
+            the number of characters of <varname>string_one</varname> read
             before this first occurrence.
         </para>
-        <para>string_one must have same dimensions than string_two or string_one
+        <para>
+            <varname>string_one</varname> must have same dimensions than <varname>string_two</varname> or <varname>string_one</varname>
             must be a string.
         </para>
     </refsection>
index 966cc55..a6259fe 100644 (file)
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="strindex" xml:lang="en">
     <refnamediv>
         <refname>strindex</refname>
-        <refpurpose>search position of a character string in an other
-            string.
+        <refpurpose>
+            search position of a character string in an other string
         </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>ind=strindex(haystack,needle,[flag])
-            [ind,which]=strindex(haystack,needle,[flag])
+        <synopsis>
+            ind = strindex(haystack, needle, [flag])
+            [ind, which] = strindex(haystack, needle, [flag])
         </synopsis>
     </refsynopsisdiv>
     <refsection>
             <varlistentry>
                 <term>haystack</term>
                 <listitem>
-                    <para>A character string. The string where to search occurrences of
-                        <literal>needle </literal>
+                    <para>
+                        a character string. The string where to search
+                        occurrences of <varname>needle</varname>.
                     </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>
+                        a character string or character string vector. The
+                        string(s) to search in <varname>haystack</varname>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>ind</term>
                 <listitem>
-                    <para>vector of indexes</para>
+                    <para>a vector of indexes.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>which</term>
                 <listitem>
-                    <para>vector of indexes</para>
+                    <para>a vector of indexes.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>flag</term>
                 <listitem>
-                    <para>string("r" for regular expression)</para>
+                    <para>
+                        a string (<literal>"r"</literal> for regular expression).
+                    </para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>strindex</literal> searches indexes where <literal>needle
-                (i)
-            </literal>
-            is found in <literal>haystack</literal>
+            <function>strindex</function> searches indexes where
+            <literal>needle(i)</literal> is found in <varname>haystack</varname>.
         </para>
         <para>
-            for each <literal>k</literal> it exist a <literal>i</literal> shuch
-            that <literal>part(haystack,ind(k)+(0:length(needle(i))-1))</literal> is
+            For each <literal>k</literal> it exist an <literal>i</literal> such
+            that <code>part(haystack,ind(k)+(0:length(needle(i))-1))</code> is
             the same string than <literal>needle(i)</literal>. If
-            <literal>which</literal> argument is required it contains these
-            <literal>i</literal>. When using the third parameters "r", the needle
-            should be a string of regular expression. And then strindex is going to
-            match it with haystack according to the regular express rules.
+            <varname>which</varname> argument is required it contains these
+            <literal>i</literal>. When using the third parameters <literal>"r"</literal>, the <varname>needle</varname>
+            should be a string of regular expression. And then <function>strindex</function> is going to
+            match it with <varname>haystack</varname> according to the regular express rules.
         </para>
         <para>
-            <literal>strindex</literal> without regular expression argument is
-            based on Knuth-Morris-Pratt algoritm.
+            <function>strindex</function> without regular expression argument is
+            based on Knuth-Morris-Pratt algorithm.
         </para>
-        <para>This algorithm is more powerful than that used in scilab 4.x. In
+        <para>
+            This algorithm is more powerful than that used in Scilab 4.x. In
             some special case, result can be different.
         </para>
-        <para>example:</para>
-        <para>// scilab 5.x</para>
+        <para>Example:</para>
+        <para>// Scilab 5.x</para>
         <para>--&gt;[k,w]=strindex('aab',['a','ab'])</para>
         <para>w = 1. 1. 2. k = 1. 2. 2.</para>
-        <para>// scilab 4.x</para>
+        <para>// Scilab 4.x</para>
         <para>--&gt;[k,w]=strindex('aab',['a','ab'])</para>
         <para>w = 1. 1. k = 1. 2.</para>
-        <para>The rules of regular expression are similar to perl language. For a
-            quick start , see <ulink url="http://perldoc.perl.org/perlrequick.html">http://perldoc.perl.org/perlrequick.html</ulink>.
+        <para>
+            The rules of regular expression are similar to Perl language. For a
+            quick start, see <ulink url="http://perldoc.perl.org/perlrequick.html">http://perldoc.perl.org/perlrequick.html</ulink>.
             For a more in-depth tutorial on , see <ulink url="http://perldoc.perl.org/perlretut.html">http://perldoc.perl.org/perlretut.html</ulink>
             and for the reference page, see <ulink url="http://perldoc.perl.org/perlre.html">http://perldoc.perl.org/perlre.html</ulink>
         </para>
index 346d040..4e75871 100644 (file)
@@ -28,8 +28,9 @@
             <varlistentry>
                 <term>x</term>
                 <listitem>
-                    <para>Boolean, complex, real, integer, polynomial matrix, implicit
-                        size, library or function
+                    <para>
+                        a boolean, complex, real, integer, polynomial matrix,
+                        an implicit size, a library or a function.
                     </para>
                 </listitem>
             </varlistentry>
     </refsection>
     <refsection>
         <title>Description</title>
-        <para>converts a matrix into a matrix of strings.</para>
         <para>
-            If <literal>x</literal> is a function <literal>[out, in, text] =
-                string(x)
-            </literal>
-            returns three vectors strings : <literal>out</literal>
-            is the vector of output variables, <literal>in</literal> is the vector of
-            input variables, and <literal>text</literal> is the (column) vector of the
+            The <function>string</function> function converts a matrix <varname>x</varname> into a matrix of strings.
+        </para>
+        <para>
+            If <varname>x</varname> is a function <code>[out, in, text] = string(x)</code>
+            returns three vectors of strings: <varname>out</varname>
+            is the vector of output variables, <varname>in</varname> is the vector of
+            input variables, and <varname>text</varname> is the (column) vector of the
             source code of the function.
         </para>
         <para>
-            If <literal>x</literal> is a <literal>lib</literal> variable
+            If <varname>x</varname> is a <literal>lib</literal> variable
             (library), text is a character string column vector. The first element
             contains the path of library file and the other the name of functions it
             defines.
             Concatenation of strings is made by the <literal>+</literal>
             operation.
         </para>
-        <para>For complex, real, integer, polynomial matrix
-            <literal>string</literal> output is managed by <link linkend="format">format</link> function (see examples).
+        <para>
+            For complex, real, integer, polynomial matrix
+            <function>string</function> output is managed by <link linkend="format">format</link> function (see examples).
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example">string(rand(2, 2))
-            
-            deff("y = mymacro(x)", "y = x + 1")
-            [out, in, text] = string(mymacro)
-            x = 123.356;
-            disp("Result is " + string(x));
-            
-            disp("/" + string(~%t) + "/");
-            disp("/" + string(%i+1) + "/");
-            disp("/" + string(int16(-123)) + "/");
-            disp("/" + string(1 + %s + %s^3) + "/");
-            
-            string(corelib)
-            
-            v = format();
-            disp(string(%pi))
-            format(24);
-            disp(string(%pi))
-            format(v(2))
-            
-            string(1:4:$)
+        <programlisting role="example">
+string(rand(2, 2))
+
+deff("y = mymacro(x)", "y = x + 1")
+[out, in, text] = string(mymacro)
+x = 123.356;
+disp("Result is " + string(x));
+
+disp("/" + string(~%t) + "/");
+disp("/" + string(%i+1) + "/");
+disp("/" + string(int16(-123)) + "/");
+disp("/" + string(1 + %s + %s^3) + "/");
+
+string(corelib)
+
+v = format();
+disp(string(%pi))
+format(24);
+disp(string(%pi))
+format(v(2))
+
+string(1:4:$)
         </programlisting>
     </refsection>
     <refsection role="see also">
         <revhistory>
             <revision>
                 <revnumber>5.4.0</revnumber>
-                <revremark>implicit size type managed as input argument.</revremark>
+                <revremark>
+                    implicit size type managed as input argument.
+                </revremark>
             </revision>
         </revhistory>
     </refsection>
index 94258f2..e7419b9 100644 (file)
     <refsection>
         <title>Description</title>
         <para>
-            Strings are defined as <literal>'string'</literal> (between quotes) or 
-            <literal>"string"</literal> (between doublequotes);
+            Strings are defined as <code>'string'</code> (between quotes) or
+            <code>"string"</code> (between doublequotes);
             matrices of strings are defined as usual constant matrices.
         </para>
         <para>
-            Concatenation of two strings is made by a <literal>+</literal> : <literal>string1+string2</literal>.
+            Concatenation of two strings is made by a <literal>+</literal>: <code>string1 + string2</code>.
         </para>
     </refsection>
     <refsection>
index f656f18..a2e5afd 100644 (file)
@@ -13,7 +13,7 @@
 <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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="strncpy">
     <refnamediv>
         <refname>strncpy</refname>
-        <refpurpose>Copy characters from strings</refpurpose>
+        <refpurpose>copy characters from strings</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
             <varlistentry>
                 <term>str1</term>
                 <listitem>
-                    <para>A character string or matrix of character strings</para>
+                    <para>
+                        a character string or matrix of character strings.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>num</term>
                 <listitem>
-                    <para>matrix Maximum number of characters to be copied from source</para>
+                    <para>
+                        an integer or a matrix of integers, maximum number of characters to be copied from source.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>res</term>
                 <listitem>
-                    <para>A character string or matrix of character strings</para>
+                    <para>
+                        a character string or matrix of character strings.
+                    </para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>res = strncpy(str1,num)</literal> Copies the first num characters of source to destination.
+            <code>res = strncpy(str1,num)</code> copies the first <varname>num</varname> characters of source <varname>str1</varname> to destination <varname>res</varname>.
+        </para>
+        <para>
+            <varname>num</varname> must have same dimensions than
+            <varname>str1</varname> or <varname>num</varname> must be an integer number.
         </para>
-        <para> num must have same dimensions than str1 or str2 must be a number. </para>
     </refsection>
     <refsection>
         <title>Examples</title>
index 5ff8b21..3c028d6 100644 (file)
 <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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="strrchr">
     <refnamediv>
         <refname>strrchr</refname>
-        <refpurpose>Find the last occurrence of a character in a string</refpurpose>
+        <refpurpose>
+            find the last occurrence of a character in a string
+        </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>res = strrchr(str1,char)</synopsis>
+        <synopsis>res = strrchr(str1, char)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
             <varlistentry>
                 <term>str1</term>
                 <listitem>
-                    <para>A character string or matrix of character strings</para>
+                    <para>
+                        a character string or matrix of character strings.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>char</term>
                 <listitem>
-                    <para>a character.</para>
+                    <para>a character or matrix of characters.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>res</term>
                 <listitem>
-                    <para>A character string or matrix of character strings</para>
+                    <para>
+                        a character string or matrix of character strings.
+                    </para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>res = strrchr(str1,char)</literal> Returns the last occurrence of character in the string str.
+            <code>res = strrchr(str1, char)</code> returns the last occurrence of character <varname>char</varname> in the string <varname>str1</varname>.
+        </para>
+        <para>
+            <varname>char</varname> must have same dimensions than
+            <varname>str1<varname> or only one character.
         </para>
-        <para> num must have same dimensions than str1 or only one char. </para>
     </refsection>
     <refsection>
         <title>Examples</title>
index a0aadda..00217a6 100644 (file)
             <varlistentry>
                 <term>str1</term>
                 <listitem>
-                    <para>A character string or matrix of character strings</para>
+                    <para>
+                        a character string or matrix of character strings.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>res</term>
                 <listitem>
-                    <para>A character string or matrix of character strings</para>
+                    <para>
+                        a character string or matrix of character strings.
+                    </para>
                 </listitem>
             </varlistentry>
         </variablelist>
@@ -39,7 +43,7 @@
     <refsection>
         <title>Description</title>
         <para>
-            <literal>res = strrev(str1)</literal> Returns string reversed.
+            <code>res = strrev(str1)</code> returns string reversed.
         </para>
     </refsection>
     <refsection>
index af2783c..016a3d6 100644 (file)
             <varlistentry>
                 <term>str</term>
                 <listitem>
-                    <para>A character string to split</para>
+                    <para>a character string to split.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>ind</term>
                 <listitem>
-                    <para>a vector of stricly increasing indices in the interval
-                        <literal>[1 length(str)-1] </literal>.
+                    <para>
+                        a vector of strictly increasing indices in the interval
+                        <literal>[1 length(str)-1]</literal>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>v</term>
                 <listitem>
-                    <para>the resulting column vector of string (dimension &gt;<literal>
-                            size(ind,'*')+1
-                        </literal>
-                        ).
+                    <para>
+                        the resulting column vector of string (dimension &gt;<literal>size(ind,'*')+1</literal>).
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>matched_separators</term>
                 <listitem>
-                    <para>a column vector of the matched separators</para>
+                    <para>
+                        a column vector of the matched separators.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>matrix_of_strings</term>
                 <listitem>
-                    <para>a matrix of strings to search in str</para>
+                    <para>
+                        a matrix of strings to search in <varname>str</varname>.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>regexp_pattern</term>
                 <listitem>
-                    <para>a regular expression pattern</para>
+                    <para>a regular expression pattern.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>limit</term>
                 <listitem>
-                    <para>maximum of limit elements</para>
+                    <para>maximum of limit elements.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>v= strsplit(str, ind)</literal> splits the string
-            <literal>str</literal> into a vector of strings at the points given by the
-            indices in <literal>ind</literal> (after each characters pointed to by the
-            index in ind).
+            <code>v= strsplit(str, ind)</code> splits the string
+            <varname>str</varname> into a vector of strings at the points given by the
+            indices in <varname>ind</varname> (after each characters pointed to by the
+            index in <varname>ind</varname>).
         </para>
         <para>
-            <literal>strsplit(str)</literal> returns same thing as
-            <literal>strsplit(str,1:length(str)-1).</literal>
+            <code>strsplit(str)</code> returns same thing as
+            <code>strsplit(str,1:length(str)-1).</code>
         </para>
         <para>
-            <literal>strsplit(str, regexp_pattern, limit)</literal> returns an
-            column vector of strings, each of which is a substring of str formed by
-            splitting it on boundaries formed by the case-sensitive regular expression
-            pattern.
+            <code>strsplit(str, regexp_pattern, limit)</code> returns an
+            column vector of strings, each of which is a substring of
+            <varname>str</varname> formed by splitting it on boundaries formed
+            by the case-sensitive regular expression pattern.
         </para>
-        <para>If there are n occurrences of pattern , the returned array will
-            contain n+1 items.
+        <para>
+            If there are <literal>n</literal> occurrences of pattern, the
+            returned array will contain <literal>n+1</literal> items.
         </para>
-        <para>For example, if there is no occurrence of pattern , an array with
-            only one element will be returned. Of course, this is also true if str is
-            empty.
+        <para>
+            For example, if there is no occurrence of pattern, an array with
+            only one element will be returned. Of course, this is also true if <varname>str</varname> is empty.
         </para>
-        <para>If limit is set, the returned array will contain a maximum of limit
-            elements with the last element containing the whole rest of string.
+        <para>
+            If <varname>limit</varname> is set, the returned array will contain
+            a maximum of limit elements with the last element containing the
+            whole rest of string.
         </para>
         <para>
-            <literal>strsplit(str, matrix_of_strings, limit)</literal> , str is
-            split on any of elements. It allows to split on different separators
-            for users without regex knowledge.
+            <code>strsplit(str, matrix_of_strings, limit)</code>,
+            <varname>str</varname> is split on any of elements. It allows to
+            split on different separators for users without regexp knowledge.
         </para>
         <para>
-            If <literal>strsplit()</literal> is called with a second output
+            If <code>strsplit()</code> is called with a second output
             argument, the column vector of the matched separators is returned.
         </para>
     </refsection>
@@ -139,6 +145,9 @@ strsplit("abcdef2ghijkl3mnopqr6stuvw7xyz","/\d+/")
         <title>See Also</title>
         <simplelist type="inline">
             <member>
+                <link linkend="part"> part</link>
+            </member>
+            <member>
                 <link linkend="strcat"> strcat</link>
             </member>
             <member>
index 106d17c..bfce040 100644 (file)
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="strspn" xml:lang="en">
     <refnamediv>
         <refname>strspn</refname>
-        <refpurpose>Get span of character set in string</refpurpose>
+        <refpurpose>get span of character set in string</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>res = strspn(str1,str2)</synopsis>
+        <synopsis>res = strspn(str1, str2)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
             <varlistentry>
                 <term>str1</term>
                 <listitem>
-                    <para>A character string or matrix of character strings</para>
+                    <para>
+                        a character string or matrix of character strings.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>str2</term>
                 <listitem>
-                    <para>A character string or matrix of character strings</para>
+                    <para>
+                        a character string or matrix of character strings.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>res</term>
                 <listitem>
-                    <para>matrix.</para>
+                    <para>a matrix of character strings.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>res = strspn(str1,str2)</literal> Returns the length of the
-            initial portion of str1 which consists only of characters that are part of
-            str2.
+            <code>res = strspn(str1, str2)</code> returns the length of the initial portion of <varname>str1</varname> which consists only of characters that are part of <varname>str2</varname>.
+        </para>
+        <para>
+            <varname>str2</varname> must have same dimensions than <varname>str1</varname> or <varname>str2</varname> must be a string.
         </para>
-        <para>str1 must have same dimensions than str2 or str1 must be a string. </para>
     </refsection>
     <refsection>
         <title>Examples</title>
index 41fee46..1fd1d27 100644 (file)
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="strstr" xml:lang="en">
     <refnamediv>
         <refname>strstr</refname>
-        <refpurpose>Locate substring</refpurpose>
+        <refpurpose>locate substring</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>res = strstr(haystack,needle)</synopsis>
+        <synopsis>res = strstr(haystack, needle)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
             <varlistentry>
                 <term>haystack</term>
                 <listitem>
-                    <para>A character string or matrix of character strings</para>
+                    <para>
+                        a character string or matrix of character strings.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>needle</term>
                 <listitem>
-                    <para>A character string or matrix of character strings</para>
+                    <para>
+                        a character string or matrix of character strings.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>res</term>
                 <listitem>
-                    <para>A character string or matrix of character strings</para>
+                    <para>
+                        a character string or matrix of character strings.
+                    </para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>res = strstr(haystack,needle)</literal> Returns a string
-            matrix starting from where the first occurrence of needle in haystack to
-            the end of haystack, or '' if there needle is not part of haystack.
+            <code>res = strstr(haystack, needle)</code> returns a string matrix
+            starting from where the first occurrence of
+            <varname>needle</varname> in <varname>haystack</varname> to the end
+            of <varname>haystack</varname>, or <literal>''</literal> if there
+            <varname>needle</varname>is not part of <varname>haystack</varname>.
         </para>
     </refsection>
     <refsection>
index 847384c..9062f79 100644 (file)
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="strsubst" xml:lang="en">
     <refnamediv>
         <refname>strsubst</refname>
-        <refpurpose>substitute a character string by another in a character
-            string.
+        <refpurpose>
+            substitute a character string by another in a character string
         </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>string_out=strsubst(string_in,searchStr,replaceStr)
-            string_out=strsubst(string_in,searchStr,replaceStr,[flag])
+        <synopsis>
+            string_out = strsubst(string_in, searchStr, replaceStr)
+            string_out = strsubst(string_in, searchStr, replaceStr, [flag])
         </synopsis>
     </refsynopsisdiv>
     <refsection>
             <varlistentry>
                 <term>string_in</term>
                 <listitem>
-                    <para>a matrix of character string. The strings where to search
-                        occurrences of <literal>searchStr</literal>
+                    <para>
+                        a matrix of character string. The strings where to
+                        search occurrences of <varname>searchStr</varname>.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>searchStr</term>
                 <listitem>
-                    <para>A character string. The string to search in
-                        <literal>string</literal>.
+                    <para>
+                        a character string. The string to search in
+                        <varname>string_in</varname>.
                     </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_out</term>
+                <term>string_out</term>
                 <listitem>
-                    <para>A matrix of character strings. The result of the substitution
-                        on <literal>searchStr</literal> by <literal>replaceStr</literal> in
-                        <literal>string</literal>
+                    <para>
+                        a matrix of character strings. The result of the
+                        substitution on <varname>searchStr</varname> by
+                        <varname>replaceStr</varname> in <varname>string_in</varname>
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>flag</term>
                 <listitem>
-                    <para>string("r" for regular expression)</para>
+                    <para>
+                        a character (<literal>"r"</literal> for regular expression).
+                    </para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>strsubst</literal> replaces all occurrences of
-            <literal>searchStr</literal> in <literal>string</literal> by
-            <literal>replaceStr</literal>.
+            The <function>strsubst</function> function replaces all occurrences of
+            <varname>searchStr</varname> in <varname>string_in</varname> by
+            <varname>replaceStr</varname>.
         </para>
-        <para>When using the forth parameters "r", the searchStr should be a
-            string of regular expression. And then strsubst is going to match it with
-            string and replace according to the regular express rules.
+        <para>
+            When using the forth parameter <literal>"r"</literal>, the <varname>searchStr</varname> should be a
+            string of regular expression. And then <function>strsubst</function> is going to match it with
+            <varname>string_in</varname> and replace according to the regular expression rules.
         </para>
     </refsection>
     <refsection>
index 7113af8..3f59107 100644 (file)
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="strtod" xml:lang="en">
     <refnamediv>
         <refname>strtod</refname>
-        <refpurpose>Convert string to double.</refpurpose>
+        <refpurpose>convert string to double</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>d =  strtod(str)
-            [d,endstr] = strtod(str)
+        <synopsis>
+            d =  strtod(str)
+            [d, endstr] = strtod(str)
         </synopsis>
     </refsynopsisdiv>
     <refsection>
             <varlistentry>
                 <term>str</term>
                 <listitem>
-                    <para>A character string or matrix of character strings</para>
+                    <para>
+                        a character string or matrix of character strings.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>d</term>
                 <listitem>
-                    <para>A real or matrix of reals</para>
+                    <para>
+                        a real or matrix of reals.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>endstr</term>
                 <listitem>
-                    <para>A character string or matrix of character strings (next
-                        character in str after the numerical value).
+                    <para>
+                        a character string or matrix of character strings (next
+                        character in <varname>str</varname> after the numerical
+                        value).
                     </para>
                 </listitem>
             </varlistentry>
@@ -49,9 +56,9 @@
     <refsection>
         <title>Description</title>
         <para>
-            <literal>[d,endstr] = strtod(str)</literal> Parses strings str
-            interpreting its content as a floating point number and returns its value
-            as a real.
+            <code>[d, endstr] = strtod(str)</code> parses strings
+            <varname>str</varname> interpreting its content as a floating point
+            number and returns its value as a real.
         </para>
     </refsection>
     <refsection>
index dfc413f..1e2a73d 100644 (file)
 <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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="strtok">
     <refnamediv>
         <refname>strtok</refname>
-        <refpurpose>Split string into tokens</refpurpose>
+        <refpurpose>split string into tokens</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>res = strtok(str,delimiters)</synopsis>
+        <synopsis>res = strtok(str, delimiters)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
             <varlistentry>
                 <term>str</term>
                 <listitem>
-                    <para>A character string</para>
+                    <para>a character string.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>delimiters</term>
                 <listitem>
-                    <para>A character string</para>
+                    <para>a character string.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>res</term>
                 <listitem>
-                    <para>A character string</para>
+                    <para>a character string.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>res = strtok(str,delimiters)</literal>  sequence of calls to this function split str into tokens, which are sequences of contiguous characters spearated by any of the characters that are part of delimiters.
+            <code>res = strtok(str, delimiters)</code>  sequence of calls to
+            this function split <varname>str</varname> into tokens, which are
+            sequences of contiguous characters separated by any of the
+            characters that are part of <varname>delimiters</varname>.
         </para>
     </refsection>
     <refsection>
index 1d7b1a3..9a544be 100644 (file)
@@ -17,7 +17,7 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>kdf=tokenpos(str [,delimiter])</synopsis>
+        <synopsis>kdf = tokenpos(str [,delimiter])</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
             <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 delimiters.
+                    </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>
+                        a two column 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>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>kdf=tokenpos(str [,delimiter]) </literal> searches the tokens included in the
-            string <literal>str</literal>. The <literal>delimiter</literal> default value is [" ",&lt;Tab&gt;]
-            where &lt;Tab&gt; stands for <literal>ascii(9)</literal>. It returns the indices of the
-            first and last characters of each found tokens.
+            <code>kdf = tokenpos(str [,delimiter]) </code> searches the tokens
+            included in the string <varname>str</varname>. The
+            <varname>delimiter</varname> default value is <literal>[" ",&lt;Tab&gt;]</literal>
+            where <literal>&lt;Tab&gt;</literal> stands for
+            <code>ascii(9)</code>. It returns the indices of the first and last
+            characters of each found tokens.
         </para>
     </refsection>
     <refsection>
index bc1c02b..2d8a67a 100644 (file)
 <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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="tokens">
     <refnamediv>
         <refname>tokens</refname>
-        <refpurpose>returns the tokens of a character string.  </refpurpose>
+        <refpurpose>returns the tokens of a character string</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>T=tokens(str [,delimiter])</synopsis>
+        <synopsis>T = tokens(str [,delimiter])</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
             <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 delimiters.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>T</term>
                 <listitem>
-                    <para>column vector of found tokens</para>
+                    <para>
+                        a column vector of found tokens.
+                    </para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>T=tokens(str [,delimiter]) </literal> searches the tokens included in the
-            string <literal>str</literal>. The <literal>delimiter</literal> default value is [" ",&lt;Tab&gt;]
-            where &lt;Tab&gt; stands for <literal>ascii(9)</literal>.
+            <code>T = tokens(str [,delimiter]) </code> searches the tokens
+            included in the string <varname>str</varname>. The
+            <varname>delimiter</varname> default value is <literal>[" ",&lt;Tab&gt;]</literal>
+            where <literal>&lt;Tab&gt;</literal> stands for <code>ascii(9)</code>.
         </para>
     </refsection>
     <refsection>