Revision of English help pages for different functions (nothing serious). 12/11212/1
Stanislav KROTER [Wed, 3 Apr 2013 14:52:11 +0000 (20:52 +0600)]
Change-Id: I237b04f4370c983fe46bd24e061159038f0ec1bb

17 files changed:
scilab/modules/core/help/en_US/debugging/whereami.xml
scilab/modules/core/help/en_US/variables/clearglobal.xml
scilab/modules/core/help/en_US/variables/isglobal.xml
scilab/modules/core/help/en_US/variables/who_user.xml
scilab/modules/core/help/en_US/variables/whos.xml
scilab/modules/data_structures/help/en_US/boolean.xml
scilab/modules/data_structures/help/en_US/getfield.xml
scilab/modules/data_structures/help/en_US/rlist.xml
scilab/modules/data_structures/help/en_US/tlist.xml
scilab/modules/differential_equations/help/en_US/dasrt.xml
scilab/modules/elementary_functions/help/en_US/elementarymatrices/linspace.xml
scilab/modules/elementary_functions/help/en_US/elementarymatrices/logspace.xml
scilab/modules/elementary_functions/help/en_US/signalprocessing/trfmod.xml
scilab/modules/fileio/help/en_US/mdelete.xml
scilab/modules/fileio/help/en_US/mopen.xml
scilab/modules/fileio/help/en_US/mtell.xml
scilab/modules/fileio/help/en_US/path_filename/basename.xml

index 96c05f3..afd66c6 100644 (file)
@@ -11,8 +11,8 @@
     <refsection>
         <title>Description</title>
         <para>
-            Displays calling tree to instruction which contain <literal>whereami()</literal>. May be
-            used within <literal>pause</literal> levels.
+            Displays calling tree to instruction which contain <code>whereami()</code>. May be
+            used within <function>pause</function> levels.
         </para>
     </refsection>
     <refsection>
index ddd1097..7fd744f 100644 (file)
@@ -6,7 +6,8 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>clearglobal()
+        <synopsis>
+            clearglobal()
             clearglobal nam1 ... namn
             clearglobal('nam1', ...,'namn')
         </synopsis>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>clearglobal()</literal> kills all the global variables.
+            <code>clearglobal()</code> kills all the global variables.
         </para>
         <para>
             <literal>clearglobal nam1 ... namn</literal>  kills  the global variables given by
             their names.
         </para>
         <para>
-            Note that <literal>clearglobal() </literal> only clears the global variables, the
-            local copies of these global variables are not destroyed.
+            <note>
+                Note that <code>clearglobal()</code> only clears 
+                the global variables, the local copies of these global 
+                variables are not destroyed.
+            </note>
         </para>
     </refsection>
     <refsection>
index ebb8ccf..c63841b 100644 (file)
@@ -6,7 +6,7 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>t=isglobal(x)</synopsis>
+        <synopsis>t = isglobal(x)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
@@ -28,7 +28,7 @@
     <refsection>
         <title>Description</title>
         <para>
-            <literal>isglobal(x)</literal> returns <emphasis>true</emphasis> if <literal>x</literal> has been declared to be a global
+            <code>isglobal(x)</code> returns <emphasis>true</emphasis> if <varname>x</varname> has been declared to be a global
             variable and <emphasis>false</emphasis> otherwise.
         </para>
     </refsection>
index 2e89c92..c2890f8 100644 (file)
@@ -15,7 +15,7 @@
                 <term>bPrint</term>
                 <listitem>
                     <para>
-                        Enable or disable screen outputs (Default: %t).
+                        enable or disable screen outputs (default: <constant>%t</constant>).
                     </para>
                 </listitem>
             </varlistentry>
@@ -28,7 +28,7 @@
                 <term>varList</term>
                 <listitem>
                     <para>
-                        Column vector of user's variables or [] if user does not have variable.
+                        a column vector of user's variables or <listing>[]</listing> if user does not have variable.
                     </para>
                 </listitem>
             </varlistentry>
@@ -42,8 +42,7 @@
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="code_scilab">
-            <![CDATA[ 
+        <programlisting role="code_scilab"><![CDATA[ 
 clear;
 who_user()
 who_user(%t)
@@ -73,7 +72,10 @@ clear;
         <revhistory>
             <revision>
                 <revnumber>5.4.0</revnumber>
-                <revremark>who_user can now return user's variable names in a column vector of character strings.</revremark>
+                <revremark>
+                    <function>who_user</function> can now return user's 
+                    variable names in a column vector of character strings.
+                </revremark>
             </revision>
         </revhistory>
     </refsection>
index 8a94739..899d2b5 100644 (file)
@@ -6,7 +6,8 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>whos()
+        <synopsis>
+            whos()
             whos -type typ
             whos -name nam
         </synopsis>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>whos()</literal> displays all current variable names sorted by name (case insensitive), types and memory used.
+            <code>whos()</code> displays all current variable names 
+            sorted by name (case insensitive), types and memory used.
         </para>
         <para>
-            <literal>whos -type typ</literal> displays all current variables with specified type.
+            <literal>whos -type typ</literal> displays all current variables with specified type <varname>typ</varname>.
         </para>
         <para>
-            <literal>whos -name nam</literal> displays all current variables whose names begin with <literal>nam</literal>.
+            <literal>whos -name nam</literal> displays all current variables whose names begin with <varname>nam</varname>.
         </para>
-        <para>Note : If a variable is global, a * appears after his type name.</para>
+        <para>
+            <note>
+                Note: If a variable is global, a <literal>*</literal> appears after its type name.
+            </para>
     </refsection>
     <refsection>
         <title>Examples</title>
index 5c1a2ca..65019f3 100644 (file)
@@ -18,7 +18,7 @@
     <refsection>
         <title>Description</title>
         <para>
-            A boolean variable is <constant>%T</constant> (for "true") or <constant>%F</constant> (for "false"). These variables can be used to define matrices of booleans, with the usual syntax. Boolean matrices can be manipulated as ordinary matrices for elements extraction/insertion and concatenation. Note that other usual operations (<literal>+</literal>, <literal>*</literal>, <literal>-</literal>, <literal>^</literal>, etc) are undefined for boolean matrices. Ğ¢hree special operators are defined for boolean matrices:
+            A boolean variable is <constant>%T</constant> (for "true") or <constant>%F</constant> (for "false"). These variables can be used to define matrices of booleans, with the usual syntax. Boolean matrices can be manipulated as ordinary matrices for elements extraction/insertion and concatenation. Note that other usual operations (<literal>+</literal>, <literal>*</literal>, <literal>-</literal>, <literal>^</literal>, etc) are undefined for boolean matrices. Three special operators are defined for boolean matrices:
         </para>
         <variablelist>
             <varlistentry>
index bcdddf0..4db00fe 100644 (file)
@@ -17,7 +17,7 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>[x,...]=getfield(i,l)</synopsis>
+        <synopsis>[x,...] = getfield(i,l)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
index f9be5ee..56d8186 100644 (file)
@@ -44,7 +44,6 @@ Den=[s*s,s;s,s*s];
 rlist(Num,Den,[])
  ]]></programlisting>
     </refsection>
-    
     <refsection role="see also">
         <title>See Also</title>
         <simplelist type="inline">
index 41ea9ef..eb9c33f 100644 (file)
@@ -71,7 +71,8 @@
         </para>
         <para>
             <code>l(i)=null()</code> removes the <literal>i</literal>-th
-            element of the <literal>tlist</literal> <literal>l</literal>.              <note>
+            element of the <literal>tlist</literal> <literal>l</literal>.
+            <note>
                 Note that the  semantics of <code>l.x=null()</code> is undefined, but a definition can be given through the <link linkend="overloading">overloading</link> mechanism.
             </note>
         </para>
@@ -79,8 +80,8 @@
             display.
         </para>
         <para>
-            Moreover if <code>typ(2:n+1)</code> are specified, user may point elements by
-            their names.
+            Moreover if <code>typ(2:n+1)</code> are specified, user may 
+            point elements by their names.
         </para>
         <para>
             We give below examples where <literal>tlist</literal> are used.
index 85ebb8f..764b6f2 100644 (file)
@@ -130,8 +130,11 @@ r=res(t,y,ydot,x1,x2,...)
                                 <literal>r=g(t,y,ydot)</literal> as a function of
                                 <literal>(t,y,ydot,x1,x2,...)</literal>.
                             </para>
-                            <para>Warning: this form must not be used if there is no extra
-                                argument to pass to <literal>the function.</literal>
+                            <para>
+                                <warning>
+                                    Warning: this form must not be used if there is no extra
+                                    argument to pass to the function.
+                                </warning>
                             </para>
                         </listitem>
                         <listitem>
index e28056c..29babd0 100644 (file)
@@ -59,6 +59,7 @@
         <title>Examples</title>
         <programlisting role="example"><![CDATA[ 
 linspace(1,2,10)
+linspace([1:4]',[5:8]',10)
 linspace(1+%i,2+2*%i,10)
  ]]></programlisting>
     </refsection>
index b801886..40d77a0 100644 (file)
@@ -43,7 +43,7 @@
         <para>
             returns a row vector of <literal>n</literal> logarithmically equally
             spaced points between <latex>10^{d1}</latex> and
-            <latex>10^{d2}</latex>. If <literal>d2=%pi</literal> then the points are
+            <latex>10^{d2}</latex>. If <latex>d2=\pi</latex> then the points are
             between <latex>10^{d1}</latex> and <latex>\pi</latex>.
         </para>
     </refsection>
@@ -51,6 +51,7 @@
         <title>Examples</title>
         <programlisting role="example"><![CDATA[ 
 logspace(1,2,10)
+logspace([1:3]',[4:6]',4)
  ]]></programlisting>
     </refsection>
     <refsection role="see also">
index 0d1971a..5247899 100644 (file)
@@ -47,7 +47,7 @@
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[
-// with a function transfert
+// with a transfer function 
 s=poly(0,'s');
 gs=syslin('c',1/(s+1));
 trfmod(gs)
index a400996..87dee50 100644 (file)
@@ -37,7 +37,7 @@
         <title>Description</title>
         <para>
             <function>mdelete</function> may be used to delete a file or a set of files if
-            <varname>filename</varname> contains meta-charaters.
+            <varname>filename</varname> contains meta-characters.
         </para>
         <para>
             <caution>
@@ -51,9 +51,8 @@
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[
-cd TMPDIR;
-r = mputl('I am a dummy String', 'dummyFile.dummy');
-mdelete("dummyFile.dummy");
+r = mputl('I am a dummy String', TMPDIR+'/dummyFile.dummy');
+mdelete(TMPDIR+"/dummyFile.dummy");
  ]]></programlisting>
     </refsection>
     
index 8b948a3..c4cb586 100644 (file)
     <refsection>
     </refsection>
     <refsection>
+        <title>Examples</title>
         <programlisting role="example"><![CDATA[
 // open a SCI+'/ACKNOWLEDGEMENTS' as text and read only
 fd_r = mopen(SCI+'/ACKNOWLEDGEMENTS', 'rt')
@@ -255,7 +256,6 @@ mclose(fd_r2);
     <refsection>
     </refsection>
     <refsection>
-        <title>Examples</title>
         <programlisting role="example"><![CDATA[
 // read/write a file as binary
 
index d1387bf..28e8a12 100644 (file)
@@ -52,7 +52,7 @@
 testFile=TMPDIR + '/testFile.bin';
 fd = mopen(testFile,'wb');
 
-mput(42,'d'); // Will open fd transparently to write 42
+mput(42,'d'); // Will write 42 in last opened file
 mtell() // Will return 8, the current position in the file descriptor
 
 mput(42+2,'d', fd); // Will open fd transparently to write 42
index 72ded5a..3b5b5c5 100644 (file)
             <varlistentry>
                 <term>flagexpand</term>
                 <listitem>
-                    <para>optional boolean, used to expand leading variables in paths.
-                        Only used with flag argument. Default value is true (<constant>%t</constant>).
+                    <para>optional boolean, used to expand leading 
+                        variables in paths. Only used with 
+                        <varname>flag</varname> argument. Default value 
+                        is true (<constant>%t</constant>).
                     </para>
                 </listitem>
             </varlistentry>