Revision of help pages of module "data_structures" (en_US, ru_RU). 07/9107/3
Stanislav KROTER [Sun, 23 Sep 2012 16:26:22 +0000 (22:26 +0600)]
Change-Id: I2769906112f65c41883ef0ef1642a857f211da5d

26 files changed:
scilab/modules/data_structures/help/en_US/boolean.xml
scilab/modules/data_structures/help/en_US/cell.xml
scilab/modules/data_structures/help/en_US/definedfields.xml
scilab/modules/data_structures/help/en_US/fieldnames.xml
scilab/modules/data_structures/help/en_US/getfield.xml
scilab/modules/data_structures/help/en_US/hypermat.xml
scilab/modules/data_structures/help/en_US/hypermatrices.xml
scilab/modules/data_structures/help/en_US/iscell.xml
scilab/modules/data_structures/help/en_US/iscellstr.xml
scilab/modules/data_structures/help/en_US/isfield.xml
scilab/modules/data_structures/help/en_US/isstruct.xml
scilab/modules/data_structures/help/en_US/list.xml
scilab/modules/data_structures/help/en_US/lsslist.xml
scilab/modules/data_structures/help/en_US/lstcat.xml
scilab/modules/data_structures/help/en_US/matrices.xml
scilab/modules/data_structures/help/en_US/mlist.xml
scilab/modules/data_structures/help/en_US/rlist.xml
scilab/modules/data_structures/help/en_US/setfield.xml
scilab/modules/data_structures/help/en_US/struct.xml
scilab/modules/data_structures/help/en_US/tlist.xml
scilab/modules/data_structures/help/en_US/type.xml
scilab/modules/data_structures/help/en_US/typename.xml
scilab/modules/data_structures/help/en_US/typeof.xml
scilab/modules/data_structures/help/ru_RU/boolean.xml
scilab/modules/data_structures/help/ru_RU/matrices.xml
scilab/modules/data_structures/help/ru_RU/null.xml

index ae9c64d..9ecc6fc 100644 (file)
@@ -1,78 +1,83 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2007-2008 - 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="boolean">
-    <refnamediv>
-        <refname>boolean</refname>
-        <refpurpose> Scilab Objects, boolean variables and operators &amp; | ~  </refpurpose>
-    </refnamediv>
-    <refsection>
-        <title>Description</title>
-        <para>
-            A boolean variable is <literal>%T</literal> (for "true") or <literal>%F</literal> (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> etc) are undefined
-            for booleans matrices. Тhree special operators are defined for boolean
-            matrices:
-        </para>
-        <variablelist>
-            <varlistentry>
-                <term>~b</term>
-                <listitem>
-                    <para>
-                        is the element-wise negation of boolean <literal>b</literal> (matrix).
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>b1&amp;b2</term>
-                <listitem>
-                    <para>
-                        is the element-wise logical <literal>and</literal> of <literal>b1</literal> and <literal>b2</literal> (matrices).
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>b1|b2</term>
-                <listitem>
-                    <para>
-                        is the  element-wise logical <literal>or</literal> of <literal>b1</literal> and <literal>b2</literal> (matrices).
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>Boolean variables can be used for indexing matrices or vectors.</term>
-                <listitem>
-                    <para>
-                        For instance <literal>a([%T,%F,%T],:)</literal> returns the submatrix  made of rows <literal>1</literal> and <literal>3</literal> of <literal>a</literal>. Boolean sparse matrices are supported.
-                    </para>
-                </listitem>
-            </varlistentry>
-        </variablelist>
-    </refsection>
-    <refsection>
-        <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+  <refnamediv>
+    <refname>boolean</refname>
+    <refpurpose> Scilab Objects, boolean variables and operators &amp; | ~  </refpurpose>
+  </refnamediv>
+  <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:
+    </para>
+    <variablelist>
+      <varlistentry>
+        <term>~b</term>
+        <listitem>
+          <para>
+            is the element-wise negation of boolean <literal>b</literal> (matrix).
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>b1 &amp; b2</term>
+        <listitem>
+          <para>
+            is the element-wise logical <literal>and</literal> of
+            <literal>b1</literal> and <literal>b2</literal>
+            (matrices).
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>b1 | b2</term>
+        <listitem>
+          <para>
+            is the  element-wise logical
+            <literal>or</literal> of <literal>b1</literal>
+            and <literal>b2</literal> (matrices).
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+    <para>
+      Boolean variables can be used for indexing matrices or vectors. For instance <code>a([%T,%F,%T],:)</code> returns the submatrix made of rows <literal>1</literal> and <literal>3</literal> of <literal>a</literal>. Boolean sparse matrices are supported.
+    </para>
+  </refsection>
+  <refsection>
+    <title>Examples</title>
+    <programlisting role="example"><![CDATA[
 [1,2]==[1,3]
 [1,2]==1
 a=1:5; a(a>2)
- ]]></programlisting>
-    </refsection>
-    <refsection role="see also">
-        <title>See Also</title>
-        <simplelist type="inline">
-            <member>
-                <link linkend="matrices">matrices</link>
-            </member>
-            <member>
-                <link linkend="or">or</link>
-            </member>
-            <member>
-                <link linkend="and">and</link>
-            </member>
-            <member>
-                <link linkend="not">not</link>
-            </member>
-        </simplelist>
-    </refsection>
+]]></programlisting>
+  </refsection>
+  <refsection role="see also">
+    <title>See Also</title>
+    <simplelist type="inline">
+      <member>
+        <link linkend="matrices">matrices</link>
+      </member>
+      <member>
+        <link linkend="or">or</link>
+      </member>
+      <member>
+        <link linkend="and">and</link>
+      </member>
+      <member>
+        <link linkend="not">not</link>
+      </member>
+    </simplelist>
+  </refsection>
 </refentry>
\ No newline at end of file
index 3ae0fe5..fe3072f 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="cell" xml:lang="en">
     <refnamediv>
         <refname>cell</refname>
-        <refpurpose>Create a cell array of empty matrices.</refpurpose>
+        <refpurpose>creates a cell array of empty matrices</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
         <synopsis>
-            c=cell()
-            c=cell(m1)
-            c=cell(m1, m2)
-            c=cell(m1, m2, ..., mn)
-            c=cell(x)
+            c = cell()
+            c = cell(m1)
+            c = cell(m1, m2)
+            c = cell(m1, m2, ..., mn)
+            c = cell(x)
         </synopsis>
     </refsynopsisdiv>
     <refsection>
             <varlistentry>
                 <term>x</term>
                 <listitem>
-                    <para>Vector containing the dimensions of the cell to create.</para>
+                    <para>
+                     a vector containing the dimensions of the cell to create.
+                   </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>m1, m2,..</term>
+                <term>m1, m2, ..., mn</term>
                 <listitem>
-                    <para>Dimensions of the cell to create.</para>
+                    <para>
+                     dimensions of the cell to create.
+                   </para>
                 </listitem>
             </varlistentry>
         </variablelist>
     </refsection>
     <refsection>
         <title>Description</title>
-        <para>Returns the create cell of empty matrices.</para>
+        <para>
+         <function>cell</function> returns a cell array of empty matrices.
+       </para>
         <variablelist>
             <varlistentry>
                 <term>cell()</term>
                 <listitem>
                     <para>
-                        returns a <literal>(0,0)</literal> cell array of empty
-                        matrices.
+                        returns a <literal>(0, 0)</literal> cell array of empty matrices.
                     </para>
                 </listitem>
             </varlistentry>
                 <term>cell(m1)</term>
                 <listitem>
                     <para>
-                        returns a <literal>(m1,m1)</literal> cell array of empty
-                        matrices.
+                        returns a <literal>(m1, m1)</literal> cell array of empty matrices.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>cell(m1,m2)</term>
+                <term>cell(m1, m2)</term>
                 <listitem>
                     <para>
-                        returns a <literal>(m1,m2) </literal>cell array of empty
-                        matrices.
+                        returns a <literal>(m1, m2) </literal> cell array of empty matrices.
                     </para>
                 </listitem>
             </varlistentry>
                 <term>cell(m1,m2,..,mn)</term>
                 <listitem>
                     <para>
-                        creates a <literal>(m1,m2,..,mn)</literal> cell array of empty
-                        matrices.
+                        creates a <literal>(m1, m2, ..., mn)</literal> cell array of empty matrices.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>cell(x)</term>
                 <listitem>
-                    <para>returns a cell array of empty matrices with: the first
-                        dimension of the cell array is <literal>x(1)</literal>, the second
-                        dimension is <literal>x(2), ...</literal>
+                    <para>
+                     returns a cell array of empty matrices with: the first dimension of the cell array is <literal>x(1)</literal>, the second dimension is <literal>x(2)</literal> and so on.
                     </para>
                 </listitem>
             </varlistentry>
     <refsection>
         <title>Remarks</title>
         <para>
-            <literal>cell(x) </literal>is not the same size that
-            <literal>x</literal>.
+            <code>cell(x)</code> is not the same size that <varname>x</varname>.
         </para>
         <para>
-            <literal>cell()</literal> is equivalent to
-            <literal>cell(0)</literal>.
+            <code>cell()</code> is equivalent to <code>cell(0)</code>.
         </para>
-        <para>If A is a cell array, you can access the contents of an element of A
-            by using <literal>A(m1, m2, ..., mn).entries</literal>, the expression
-            <literal>A(1,1) = zeros(2,2)</literal> is not valid, the right syntax is
-            <literal>A(1,1).entries = zeros(2,2)</literal>.
+        <para>
+         If <literal>A</literal> is a cell array, you can access the contents of an element of <literal>A</literal> by using <code>A(m1, m2, ..., mn).entries</code>. The expression <code>A(1,1) = zeros(2,2)</code> is not valid, the right syntax is
+            <code>A(1,1).entries = zeros(2,2)</code>.
         </para>
-        <para>If A is a cell array, you can get its dimensions by using
-            <literal>A.dims</literal> which returns an <literal>int32</literal> value that cannot be used as a subscript for the cell array. In this case, the best way to get the cell array dimensions is <literal>size(A)</literal>.
+        <para>
+         If <literal>A</literal> is a cell array, you can get its dimensions by using <code>A.dims</code> which returns an <literal>int32</literal> value that cannot be used as a subscript for the cell array. In this case, the best way to get the cell array dimensions is <code>size(A)</code>.
         </para>
     </refsection>
     <refsection>
 a=cell(3)
 b=cell(3,1)
 c=cell([2,3,4])
-
 // Assigning cell entries
 b=cell(3,1);
-
 // Assigning the first element of b using the 'entries' field
 b(1).entries=1:3
-
 // Assigning the second element of b using the 'entries' field
 b(2).entries='Scilab'
-
 // Assigning the third element of b using the 'entries' field
 b(3).entries=poly(1:3,'s')
-
 // Assigning sub-cells
 X=cell(3,2);
 X(:,1)=b
-
 // Extracting a sub-cell: result is a cell
 b(1)
 b(1:2)
-
 // Extracting a sub-cell value: result is an array
 b(1).entries
-
-// Dimensions of b as an int32 value (cannont be used as an index)
+// Dimensions of b as an int32 value (cannot be used as an index)
 b.dims
 // Dimensions of b as a double value
 size(b)
-
  ]]></programlisting>
     </refsection>
     <refsection role="see also">
@@ -164,3 +162,4 @@ size(b)
         </simplelist>
     </refsection>
 </refentry>
\ No newline at end of file
index 0a58f8a..4ddb890 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="definedfields">
     <refnamediv>
         <refname>definedfields</refname>
-        <refpurpose> return index of list's defined fields</refpurpose>
+        <refpurpose>returns an index of list's defined fields</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>k=definedfields(l)</synopsis>
+        <synopsis>k = definedfields(lst)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
         <variablelist>
             <varlistentry>
-                <term>l</term>
+                <term>lst</term>
                 <listitem>
-                    <para>a list , tlist or mlist variable.</para>
+                    <para>a list, tlist or mlist variable.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
     <refsection>
         <title>Description</title>
         <para>
-            If <literal>l</literal> is a  <literal>list</literal>  <literal>tlist</literal>
-            <literal>mlist</literal>  <literal>k=definedfields(l)</literal> returns in
-            <literal>k</literal> the indices of the defined list fields. This
-            function is useful because indexing undefined fields produces an
-            error.
+            If <varname>lst</varname> is a <literal>list</literal>, a <literal>tlist</literal>, a <literal>mlist</literal> <code>k = definedfields(lst)</code> returns in  <varname>k</varname> the indices of the defined list fields. This function is useful because indexing undefined fields produces an error.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[ 
-l=list(1);l(3)=5
-k=definedfields(l)
-
+lst=list(1);lst(3)=5
+k=definedfields(lst)
 t=tlist('x');t(5)=4
 definedfields(t)
-
 m=mlist(['m','a','b']);m.b='sdfgfgd'
 definedfields(m)
  ]]></programlisting>
index b42df4b..86a2492 100644 (file)
@@ -40,8 +40,8 @@
     <refsection>
         <title>Description</title>
         <para>
-            The <literal>fieldnames</literal> function returns field names
-            of a tlist, mlist or struct. <literal>fieldnames</literal>
+            The <function>fieldnames</function> function returns field names
+            of a <literal>tlist</literal>, <literal>mlist</literal> or <literal>struct</literal>. <function>fieldnames</function>
             does not work on cells.
         </para>
     </refsection>
index 6bb1052..fca4852 100644 (file)
             <varlistentry>
                 <term>x</term>
                 <listitem>
-                    <para>matrix  of any  possible types</para>
+                    <para>matrix of any possible types.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>l</term>
                 <listitem>
-                    <para>list, tlist or mlist variable</para>
+                    <para><literal>list</literal>, <literal>tlist</literal> or <literal>mlist</literal> variable.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>i</term>
                 <listitem>
-                    <para>field index, see extraction for more details.</para>
+                    <para>field index, see <link linkend="extraction">extraction</link> for more details.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 l=list(1,'qwerw',%s)
 [a,b]=getfield([3 2],l)
-
 a=hypermat([2,2,2],rand(1:2^3));// hypermatrices are coded using mlists
 a(1) // the a(1,1,1) entry
 getfield(1,a) // the mlist first field
@@ -70,3 +70,4 @@ getfield(1,a) // the mlist first field
         </simplelist>
     </refsection>
 </refentry>
\ No newline at end of file
index 994088d..89c8f12 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="hypermat">
     <refnamediv>
         <refname>hypermat</refname>
-        <refpurpose> initialize an  N dimensional matrices</refpurpose>
+        <refpurpose>initializes an  N dimensional matrix</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>M=hypermat(dims [,v])</synopsis>
+        <synopsis>M = hypermat(dims [,v])</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
             <varlistentry>
                 <term>dims</term>
                 <listitem>
-                    <para>vector of hypermatrix dimensions</para>
+                    <para>a vector of hypermatrix dimensions.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>v</term>
                 <listitem>
                     <para>
-                        vector of hypermatrix entries (default value <literal>zeros(prod(dims),1)</literal>)
+                        a vector of hypermatrix entries (default value <code>zeros(prod(dims),1)</code>).
                     </para>
                 </listitem>
             </varlistentry>
     <refsection>
         <title>Description</title>
         <para>
-            Initialize a hypermatrix whose dimensions are given in the vector dims
-            and entries are given in optional argument <literal>v</literal>
+         The <function>hypermat</function> function initializes a hypermatrix whose dimensions are given in the vector <varname>dims</varname> and entries are given in optional argument <varname>v</varname>.
         </para>
         <para>
-            M data structure contains the vector of matrix dimensions
-            <literal>M('dims')</literal> and the vector of entries <literal>M('entries')</literal> such as
+         <varname>M</varname> data structure contains the vector of matrix dimensions
+            <code>M('dims')</code> and the vector of entries <code>M('entries')</code> such as
             the leftmost subcripts vary first
             <literal>[M(1,1,..);..;M(n1,1,..);...;M(1,n2,..);..;M(n1,n2,..);...]</literal>
         </para>
         <para>
-            Warning: If you build your own <literal>hypermat</literal>, you must be careful. The M('dims') entry must be a row vector whereas the M('entries') must be a column vector.
+         <warning>
+           If you build your own <function>hypermat</function>, you must be careful. The <code>M('dims')</code> entry must be a row vector whereas the <code>M('entries')</code> must be a column vector.
+         </warning>
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 M = hypermat([2 3 2 2],1:24)
 disp(size(M('dims')))
 disp(size(M('entries')))
-
 M_own            = mlist(['hm','dims','entries']);
 M_own('dims')    = [2 3 2 2];
 M_own('entries') = [1:24]';
index 5aa7751..f4cf3f7 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="hypermatrices">
     <refnamediv>
         <refname>hypermatrices</refname>
-        <refpurpose> Scilab object, N dimensional matrices in Scilab</refpurpose>
+        <refpurpose>a Scilab object, N dimensional matrix in Scilab</refpurpose>
     </refnamediv>
     <refsection>
         <title>Description</title>
         <para>
-            Hypermatrix type allows to manipulate multidimensional arrays
+            Hypermatrix type allows to manipulate multidimensional arrays.
         </para>
         <para>
             They can be defined by extension of 2D matrices as follows
-            a=[1 2;3 4];a(:,:,2)=rand(2,2)
+            <code>a=[1 2;3 4];a(:,:,2)=rand(2,2)</code> or directly using <function>hypermat</function> function.
         </para>
         <para>
-            or directly using <literal>hypermat</literal> function
-        </para>
-        <para>
-            Entries  can be real or complex numbers, polynomials,
+            Entries can be real or complex numbers, polynomials,
             rationals, strings, booleans.
         </para>
         <para>
             Hypermatrices are <literal>mlists</literal>:
-            <literal>mlist(['hm','dims','entries'],sz,v)</literal> where <literal>sz</literal> is the row
+            <code>mlist(['hm','dims','entries'],sz,v)</code> where <literal>sz</literal> is the row
             vector of dimensions and <literal>v</literal> the column vector of entries (first
-            dimension are stored first)
+            dimension are stored first).
         </para>
-        <para>NOTES: The number of dimension of hypermatrices with right-most sizes equal to
+        <para>
+          <note>
+            The number of dimension of hypermatrices with right-most sizes equal to
             1 are automatically reduced. An hypermatrix with only two dimensions is
             automatically changed to a regular matrix (type 1).
+          </note>
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 a(1,1,1,1:2)=[1 2]
 a=[1 2;3 4];a(:,:,2)=rand(2,2)
 a(1,1,:)
-
 size(a)
-
-a(:,:,1) //dimensionnality reduction
+a(:,:,1) //dimensionality reduction
 type(a(:,:,1))
-
 [a a]
  ]]></programlisting>
     </refsection>
index 71729ee..5dc5c18 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: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="iscell" xml:lang="en">
     <refnamediv>
         <refname>iscell</refname>
-        <refpurpose>Check if a variable is a cell array</refpurpose>
+        <refpurpose>checks if a variable is a cell array</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
             <varlistentry>
                 <term>x</term>
                 <listitem>
-                    <para>Scilab variable</para>
+                    <para>a Scilab variable.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>bool</term>
                 <listitem>
-                    <para>A boolean</para>
+                    <para>a boolean.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>iscell(x)</literal> returns true if x is a cell array
-            and false otherwise.
+            <code>iscell(x)</code> returns <constant>%t</constant>if
+            <varname>x</varname> is a cell array and <constant>%f</constant> otherwise.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[ 
 iscell(1)
-
 iscell(cell())
-
 c = cell(1,2);
 c(1).entries="Scilab";
 c(2).entries=datenum();
index af46aea..72cbe15 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: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="iscellstr" xml:lang="en">
     <refnamediv>
         <refname>iscellstr</refname>
-        <refpurpose>Check if a variable is a cell array of strings</refpurpose>
+        <refpurpose>checks if a variable is a cell array of strings</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
             <varlistentry>
                 <term>x</term>
                 <listitem>
-                    <para>Scilab variable</para>
+                    <para>a Scilab variable.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>bool</term>
                 <listitem>
-                    <para>A boolean</para>
+                    <para>a boolean.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>iscellstr(x)</literal> returns true if x is a cell array of
-            strings (or an empty cell array) and false otherwise.
+            <code>iscellstr(x)</code> returns <constant>%t</constant> if <varname>x</varname> is a cell array of
+            strings (or an empty cell array) and <constant>%f</constant> otherwise.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[ 
 iscellstr(1)
-
 iscellstr(cell())
-
 iscellstr(cell(3))
-
 strcell = cell(3,1);
 strcell(1).entries="Scilab";
 strcell(2).entries="iscellstr";
index fa3bcd7..d9953dd 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="isfield">
     <refnamediv>
         <refname>isfield</refname>
-        <refpurpose>Checks if the given fieldname exists in the structure</refpurpose>
+        <refpurpose>checks if the given fieldname exists in the structure</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>bool = isfield(s,fieldname)</synopsis>
+        <synopsis>bool = isfield(s, fieldname)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
             <varlistentry>
                 <term>s</term>
                 <listitem>
-                    <para>A struct array</para>
+                    <para>a struct array.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>fieldname</term>
                 <listitem>
-                    <para>A matrix of strings</para>
+                    <para>a matrix of strings.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>bool</term>
                 <listitem>
-                    <para>A matrix of boolean.</para>
+                    <para>a matrix of boolean.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            This function returns true if the specified structure "s" includes the field
-            "field", regardless of the corresponding value.
+            This function returns <constant>%t</constant> if the specified structure <varname>s</varname> includes the field <varname>fieldname</varname>, regardless of the corresponding value.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[ 
 s = struct("field_1",123,"field_2",456,"field_4",789)
-
 // Single Fieldname Syntax
 isfield( s , "field_1"  )
-
 // Multiple Fieldname Syntax
 isfield( s , [ "field_1" "field_2" ; "field_3" "field_4" ] )
  ]]></programlisting>
index e7688dc..0e3a3b0 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: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="isstruct" xml:lang="en">
     <refnamediv>
         <refname>isstruct</refname>
-        <refpurpose>Check if a variable is a structure array</refpurpose>
+        <refpurpose>checks if a variable is a structure array</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
             <varlistentry>
                 <term>x</term>
                 <listitem>
-                    <para>Scilab variable</para>
+                    <para>a Scilab variable.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>bool</term>
                 <listitem>
-                    <para>A boolean</para>
+                    <para>a boolean.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>isstruct(x)</literal> returns true if x is a struct array
-            and false otherwise.
+            <code>isstruct(x)</code> returns <constant>%t</constant> if
+            <varname>x</varname> is a struct array and <constant>%f</constant> otherwise.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[ 
 isstruct(1)
-
 isstruct(cell())
-
 isstruct(struct("name","Scilab", "version", getversion()))
-
 info.name="Scilab";
 info.function="isstruct";
 info.module="help";
@@ -70,3 +70,4 @@ isstruct(info)
         </simplelist>
     </refsection>
 </refentry>
\ No newline at end of file
index 99c0c21..7198ce8 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="list">
     <refnamediv>
         <refname>list</refname>
-        <refpurpose> Scilab object and list function definition</refpurpose>
+        <refpurpose>a Scilab object and a list definition function</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>list(a1,....an)</synopsis>
+        <synopsis>list(a1, ..., an)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Description</title>
         <para>
-            Creates a <literal>list</literal> with elements <literal>ai</literal>'s which are arbitrary Scilab
-            objects (<literal>matrix, list,...</literal>). Type of <literal>list</literal> objects is 15.
-            <literal>list()</literal> creates the empty <literal>list</literal> (0 element).
+            Creates a <literal>list</literal> with elements
+            <varname>ai</varname>'s which are arbitrary Scilab objects
+            (<literal>matrix</literal>,
+            <literal>list</literal>,...). Type of
+            <literal>list</literal> objects is 15. <code>list()</code>
+            creates the empty <literal>list</literal> (0 element).
         </para>
     </refsection>
     <refsection>
@@ -34,8 +37,8 @@
                 <term>extraction</term>
                 <listitem>
                     <para>
-                        <literal>[x,y,z...]=L(v)</literal> where <literal>v</literal> is a vector of indices;
-                        <literal>[x,y,z]=L(:)</literal> extracts all the elements.
+                        <literal>[x,y,z,...]=L(v)</literal> where <literal>v</literal> is a vector of indices;
+                        <literal>[x,y,z,...]=L(:)</literal> extracts all the elements.
                     </para>
                 </listitem>
             </varlistentry>
                 <term>insertion at index i</term>
                 <listitem>
                     <para>
-                        <literal>L(i)=a</literal> (note that it is not an error to use <literal>L(i)=a</literal>
-                        with <emphasis>i &gt; 1 + size(L)</emphasis> but some list entries are then undefined
-                        and their extraction gives raise to an error).
+                        <code>L(i)=a</code> (note that it is not an
+                        error to use <code>L(i)=a</code> with
+                        <code><![CDATA[i > 1 + size(L)]]></code> but
+                        some list entries are then undefined and their
+                        extraction gives raise to an error).
                     </para>
                 </listitem>
             </varlistentry>
@@ -53,7 +58,7 @@
                 <term>append an element in queue</term>
                 <listitem>
                     <para>
-                        <literal>L($+1)=e</literal>.
+                        <code>L($+1)=e</code>.
                     </para>
                 </listitem>
             </varlistentry>
                 <term>append an element in head</term>
                 <listitem>
                     <para>
-                        <literal>L(0)=e</literal>. (note that after this operation <literal>e</literal> is
-                        at index 1, the initial elements being shifted on the right).
+                        <code>L(0)=e</code>.
+                        <note>
+                          After this
+                          operation <literal>e</literal> is an index 1,
+                          the initial elements being shifted on the
+                          right.
+                        </note>
                     </para>
                 </listitem>
             </varlistentry>
@@ -70,7 +80,7 @@
                 <term>deletion</term>
                 <listitem>
                     <para>
-                        <literal>L(i)=null()</literal> removes the i-th element of the list <literal>L</literal>.
+                        <code>L(i)=null()</code> removes the <literal>i</literal>-th element of the list <literal>L</literal>.
                     </para>
                 </listitem>
             </varlistentry>
@@ -78,7 +88,7 @@
                 <term>concatenation of two lists</term>
                 <listitem>
                     <para>
-                        <literal>L3 = lstcat(L1,L2)</literal>.
+                        <code>L3 = lstcat(L1,L2)</code>.
                     </para>
                 </listitem>
             </varlistentry>
@@ -86,8 +96,8 @@
                 <term>number of elements of a list</term>
                 <listitem>
                     <para>
-                        you can use either <literal>nb_elm = size(L)</literal>
-                        or <literal>nb_elm = length(L)</literal>.
+                        you can use either <code>nb_elm = size(L)</code>
+                        or <code>nb_elm = length(L)</code>.
                     </para>
                 </listitem>
             </varlistentry>
                         it is possible to use a list <literal>L</literal> with a <link linkend="for">for</link> loop:
                         <literal>for e=L,...,end</literal> is a loop with <literal>length(L)</literal>
                         iterations, the loop variable <literal>e</literal> being equal to <literal>L(i)</literal>
-                        at the i th iteration.
+                        at the <literal>i</literal>-th iteration.
                     </para>
                 </listitem>
             </varlistentry>
             Scilab provides also other kinds of list, the <link linkend="tlist">tlist</link> type (typed list) and
             the <link linkend="mlist">mlist</link> type which are useful to define a new data type with operator
             <link linkend="overloading">overloading</link> facilities (<link linkend="hypermatrices">hypermatrices</link> which are
-            multi-dimensionnal arrays in scilab are in fact <emphasis>mlist</emphasis>).
+            multidimensional arrays in Scilab are in fact <emphasis>mlist</emphasis>).
         </para>
         <para>
             Matlab <emphasis>struct</emphasis> are also available.
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 l = list(1,["a" "b"])
 l(0) = "foo"
 l($+1) = "hello"
index 9573974..3e580e8 100644 (file)
     <refsynopsisdiv>
         <title>Calling Sequence</title>
         <synopsis>lsslist()
-            lsslist(a1,....an)
+            lsslist(a1, ..., an)
         </synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>lsslist(a1,....an)</literal> is a shortcut to
-            <literal>tlist(['lss','A';'B';'C';'X0','dt'], a1,....an)</literal>
+            <literal>lsslist(a1, ..., an)</literal> is a shortcut to
+            <literal>tlist(['lss','A';'B';'C';'X0','dt'], a1, ..., an)</literal>.
         </para>
         <para>
             Creates a <literal>tlist</literal> with  <literal>['lss','A';'B';'C';'X0','dt']</literal> as
-            first entry and  <literal>ai</literal>'s as next entries if any. No type nor size
-            checking is done on <literal>ai</literal>'s.
+            first entry and  <varname>ai</varname>'s as next entries if any. No type nor size
+            checking is done on <varname>ai</varname>'s.
         </para>
     </refsection>
     <refsection role="see also">
index 938b3d0..686e88e 100644 (file)
@@ -17,7 +17,7 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>lc=lstcat(l1,..ln)</synopsis>
+        <synopsis>lc = lstcat(l1, ..., ln)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
@@ -25,7 +25,7 @@
             <varlistentry>
                 <term>li</term>
                 <listitem>
-                    <para>list or any other type of variable</para>
+                    <para>a list or any other type of variable</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>lc=lstcat(l1,..ln)</literal> catenates components of <literal>li</literal> lists in a
-            single list. If the <literal>li</literal> are other type of variables they are simply
+            <literal>lc = lstcat(l1, ..., ln)</literal> concatenates components of <varname>li</varname> lists in a
+            single list <varname>lc</varname>. If the <varname>li</varname> are other type of variables they are simply
             added to the resulting list.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 lstcat(list(1,2,3),33,list('foo',%s))
 lstcat(1,2,3)
  ]]></programlisting>
index 919efa8..8830e9f 100644 (file)
@@ -1,8 +1,19 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2006-2012 - 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="matrices">
     <refnamediv>
         <refname>matrices</refname>
-        <refpurpose> Scilab object, matrices in Scilab</refpurpose>
+        <refpurpose>Scilab objects, matrices in Scilab</refpurpose>
     </refnamediv>
     <refsection>
         <title>Description</title>
@@ -10,7 +21,7 @@
             Matrices are basic objects defined in Scilab.
             They can be defined as follows:
         </para>
-        <programlisting role="no-scilab-exec"><![CDATA[ 
+        <programlisting role="no-scilab-exec"><![CDATA[
 E=[e11,e12,...,e1n;
    e21,e22,...,e2n;
         ....
@@ -26,7 +37,7 @@ E=[e11,e12,...,e1n;
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 E=[1,2;3,4]
 E=[%T,%F;1==1,1~=1]
 s=poly(0,'s');
@@ -56,6 +67,9 @@ E=['A11','A12';'A21','A22']
             <member>
                 <link linkend="hypermatrices">hypermatrices</link>
             </member>
+            <member>
+                <link linkend="testmatrix">testmatrix</link>
+            </member>
         </simplelist>
     </refsection>
 </refentry>
index afc0c76..1b67ab7 100644 (file)
     <refnamediv>
         <refname>mlist</refname>
         <refpurpose>Scilab object, matrix oriented typed list
-            definition.
+            definition
         </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>mlist(typ,a1,....an )</synopsis>
+        <synopsis>mlist(typ, a1, ..., an)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
             <varlistentry>
                 <term>typ</term>
                 <listitem>
-                    <para>vector of character strings</para>
+                    <para>a vector of character strings.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>ai</term>
                 <listitem>
                     <para>
-                        any Scilab object (<literal>matrix, list,string...</literal>).
+                        any Scilab object (<literal>matrix</literal>, <literal>list</literal>, <literal>string</literal>, ...).
                     </para>
                 </listitem>
             </varlistentry>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>mlist</literal> object are very similar to <link linkend="tlist">tlist</link> objects.
-            The only difference concerns the <link linkend="extraction">extraction</link>  and <link linkend="insertion">insertion</link>   syntax:
-            if <literal>M</literal> is an mlist, for any index <literal>i</literal> which is
-            not a field name, <literal>M(i)</literal> is no more the <literal>i</literal>th
+            <link linkend="mlist">mlist</link> object is very similar to <link linkend="tlist">tlist</link> object.
+            The only difference concerns the <link linkend="extraction">extraction</link>  and <link linkend="insertion">insertion</link> syntax:
+            if <literal>M</literal> is an <literal>mlist</literal>, for any index <literal>i</literal> which is
+            not a field name, <literal>M(i)</literal> is no more the <literal>i</literal>-th
             field of the list.
         </para>
-        <para> The semantic of the extraction and insertion syntax should be given by
-            an <link linkend="overloading">overloading</link> functions.
+        <para>
+            The semantic of the extraction and insertion syntax should be given by
+            an <link linkend="overloading">overloading</link> function.
         </para>
         <para>
-            The overloading function for extraction syntax <literal>b=a(i1,...,in)</literal>
-            has the following calling sequence: <literal>b=%&lt;type_of_a&gt;_e_(i1,...,in,a)</literal> 
+            The overloading function for extraction syntax <literal>b=a(i1, ..., in)</literal>
+            has the following calling sequence: <literal>b=%&lt;type_of_a&gt;_e_(i1, ..., in, a)</literal>
         </para>
         <para>and the syntax
-            <literal>[x1,..,xm]=a(i1,...,in)</literal> has the following calling sequence:
-            <literal>[x1,..,xm]=%&lt;type_of_a&gt;_e_(i1,...,in,a)</literal>
+            <literal>[x1, ..., xm]=a(i1, ..., in)</literal> has the following calling sequence:
+            <literal>[x1, ..., xm]=%&lt;type_of_a&gt;_e_(i1, ..., in,a)</literal>
         </para>
         <para/>
         <para> The overloading function associated to the insertion syntax
-            <literal>a(i1,...,in)=b</literal>  has the following calling sequence:
-            <literal>a=%&lt;type_of_b&gt;_i_&lt;type_of_a&gt;(i1,...,in,b,a)</literal>. 
+            <literal>a(i1, ..., in)=b</literal>  has the following calling sequence:
+            <literal>a=%&lt;type_of_b&gt;_i_&lt;type_of_a&gt;(i1, ..., in, b, a)</literal>.
         </para>
         <para/>
-        <para>mlist fields must then be designed by their names. They can also be
-            handled using the <literal>getfield</literal> and <literal>setfield</literal>
+        <para><literal>mlist</literal> fields must then be designed by their names. They can also be
+            handled using the <function>getfield</function> and <function>setfield</function>
             functions.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 M=mlist(['V','name','value'],['a','b';'c' 'd'],[1 2; 3 4]);
 //define display
 function %V_p(M),disp(M.name+':'+string(M.value)),endfunction
-
 //define extraction operation
 function r=%V_e(varargin)
   M=varargin($)
@@ -85,7 +86,7 @@ function r=%V_e(varargin)
 endfunction
 M(2,:) // the second row of  M
 M.value
-
 //define insertion operations
 function M=%V_i_V(varargin)
   M=varargin($)
@@ -94,7 +95,7 @@ function M=%V_i_V(varargin)
   M.name(varargin(1:$-2))=N.name
 endfunction
 M(1,1)=M(2,2)
-
 function M=%s_i_V(varargin) //insertion of a regular matrix into a V matrix
   M=varargin($)
   N=varargin($-1)
@@ -102,12 +103,12 @@ function M=%s_i_V(varargin) //insertion of a regular matrix into a V matrix
   M.name(varargin(1:$-2))=emptystr(N)
 endfunction
 M(1,1)=44
-
 //tlist case
 M=tlist(['V','name','value'],['a','b';'c' 'd'],[1 2; 3 4]);
 M(2)
 M(2)='a'+string([1 2;3 4])
-
 M('name')
  ]]></programlisting>
     </refsection>
index 4fd18d7..e9ca02f 100644 (file)
     <refsynopsisdiv>
         <title>Calling Sequence</title>
         <synopsis>rlist()
-            rlist(a1,....an)
+            rlist(a1 ,..., an)
         </synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>rlist(a1,....an)</literal> is a shortcut  to
-            <literal>tlist(['r','num';'den','dt'], a1,....an)</literal>
+            <literal>rlist(a1, ..., an)</literal> is a shortcut  to
+            <literal>tlist(['r','num';'den','dt'], a1, ..., an)</literal>.
         </para>
         <para>
-            Creates a <literal>tlist</literal> with  <literal>['r','num';'den','dt']</literal> as
+            <literal>rlist(a1, ..., an)</literal> creates a <literal>tlist</literal> with  <literal>['r','num';'den','dt']</literal> as
             first entry and  <literal>ai</literal>'s as next entries if any. No type nor size
             checking is done on <literal>ai</literal>'s.
         </para>
index a55d5d0..5dbc079 100644 (file)
@@ -17,7 +17,7 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>setfield(i,x,l)</synopsis>
+        <synopsis>setfield(i, x, l)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
             <varlistentry>
                 <term>x</term>
                 <listitem>
-                    <para>matrix  of any  possible types</para>
+                    <para>a matrix of any possible types.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>l</term>
                 <listitem>
-                    <para>list, tlist or mlist variable</para>
+                    <para>
+                      a <literal>list</literal>, <literal>tlist</literal> or <literal>mlist</literal> variable.
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>i</term>
                 <listitem>
-                    <para>field index, see insertion for more details.</para>
+                    <para>a field index, see <link linkend="insertion">insertion</link> for more details.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            This function is an equivalent of <literal>l(i)=x</literal> syntax for field
+            This function is an equivalent of <code>l(i)=x</code> syntax for field
             extraction with the only difference that it also applies to
             <literal>mlist</literal> objects.
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 l=list(1,'qwerw',%s)
 l(1)='Changed'
 l(0)='Added'
 l(6)=['one more';'added']
-
 a=hypermat([2,2,2],rand(1:2^3));// hypermatrices are coded using mlists
 setfield(3,1:8,a);a // set the field value to 1:8
  ]]></programlisting>
index 157e46f..9143d3a 100644 (file)
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>st=struct(field1,value1,field2,value2...)</synopsis>
+        <synopsis>st = struct(field1, value1, field2, value2, ...)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
         <variablelist>
             <varlistentry>
-                <term>field1, field2, ..</term>
+                <term>field1, field2, ...</term>
                 <listitem>
-                    <para>strings represents the fields names</para>
+                    <para>strings representing the fields names.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
-                <term>value1, value2, ..</term>
+                <term>value1, value2, ...</term>
                 <listitem>
-                    <para>all data type (double, char, int, ...), represents the fields
-                        values
+                    <para>all data type (<literal>double</literal>, <literal>char</literal>, <literal>int</literal>, ...), representing the fields values.
                     </para>
                 </listitem>
             </varlistentry>
     </refsection>
     <refsection>
         <title>Description</title>
-        <para>This function returns a struct with the fields names
-            <literal>fields1</literal>, <literal>field2</literal>, ..., and the fields values
-            corresponding <literal>value1</literal>, <literal>value2</literal>, ...
+        <para>
+            This function returns a struct with the fields names
+            <varname>fields1</varname>, <varname>field2</varname>, ..., and the fields values
+            corresponding <varname>value1</varname>, <varname>value2</varname>, ...
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
-        <programlisting role="example"><![CDATA[ 
-// create a struct date
+        <programlisting role="example"><![CDATA[
+//create a struct date
 date_st=struct('day',25,'month' ,'DEC','year',2006)
-
 //change the month
 date_st.month='AUG';
-
-// change the year
+//change the year
 date_st.year=1973;
-
 //change the day
 date_st.day=19;
-
-// add a new field
+//add a new field
 date_st.semaine=32
  ]]></programlisting>
     </refsection>
index 421d06d..5c6049a 100644 (file)
@@ -17,7 +17,7 @@
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
-        <synopsis>tlist(typ,a1,....an )</synopsis>
+        <synopsis>tlist(typ, a1, ..., an)</synopsis>
     </refsynopsisdiv>
     <refsection>
         <title>Arguments</title>
             <varlistentry>
                 <term>typ</term>
                 <listitem>
-                    <para>Character string or vector of character strings</para>
+                    <para>a character string or vector of character strings.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>ai</term>
                 <listitem>
                     <para>
-                        Any Scilab object (<literal>matrix, list,string...</literal>).
+                        any Scilab object (<literal>matrix</literal>, <literal>list</literal>,
+                        <literal>string</literal>, ...).
                     </para>
                 </listitem>
             </varlistentry>
     <refsection>
         <title>Description</title>
         <para>
-            Creates a <literal>typed-list</literal> with elements <literal>ai</literal>'s. The <literal>typ</literal>
-            argument specifies the list type. Such <literal>typed-list</literal> allow the user
-            to define new operations working on these object through scilab
-            functions. The only difference between <literal>typed-list</literal> and <literal>list</literal>
-            is the value of the type (16 instead of 15).
+            <literal>tlist(typ, a1, ..., an)</literal> creates a <literal>typed-list</literal> with elements <varname>ai</varname>'s. The <varname>typ</varname> argument specifies the list type. Such <literal>typed-list</literal> allows the user to define new operations working on these object through Scilab functions. The only difference between <literal>typed-list</literal> and <literal>list</literal> is the value of the type (16 instead of 15).
         </para>
         <para>
-            <literal>typ(1)</literal> specifies the list type (character string used to define
-            soft coded operations)
+            <code>typ(1)</code> specifies the list type (character string used to define soft coded operations).
         </para>
         <para>
-            if specified <literal>typ(i)</literal> may give the <literal>i+1</literal>th element formal name
+            If specified <code>typ(i)</code> may give the <literal>(i+1)</literal>-th element formal name.
         </para>
         <para>
             Standard Operations on <literal>list</literal> work similarly for <literal>typed-list</literal>:
         </para>
         <para>
-            extraction
-            : <literal>[x,y,z...]=l(v)</literal> where <literal>v</literal> is a vector of indices;
-            <literal>[x,y,z]=l(:)</literal> extracts all the elements.
+            extraction:
         </para>
         <para>
-            insertion
-            : <literal>l(i)=a</literal>
+            <literal>[x, y, z, ...]=l(v)</literal> where <literal>v</literal> is a vector of indices;
+            <literal>[x, y, z]=l(:)</literal> extracts all the elements.
         </para>
         <para>
-            deletion : <literal>l(i)=null()</literal> removes the i-th
-            element of the <literal>tlist l</literal>. Note that the
-            semantics of <literal>l.x=null()</literal> is undefined, but a
-            definition can be given through the <link linkend="overloading">overloading</link> mechanism.
+            insertion:
         </para>
         <para>
-            display
+            <literal>l(i)=a</literal>
         </para>
         <para>
-            Moreover if <literal>typ(2:n+1)</literal> are specified, user may point elements by
-            their names
+            deletion:
         </para>
         <para>
-            We give below examples where tlist are used.
+            <code>l(i)=null()</code> removes the <literal>i</literal>-th
+            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>
+        <para>
+            display.
+        </para>
+        <para>
+            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.
         </para>
         <para>
             Linear systems are represented by specific <literal>typed-list</literal> e.g. a
-            linear system <literal>[A,B,C,D]</literal> is represented by the tlist
-            <literal>Sys=tlist(['lss';'A';'B';'C';'D';'X0';'dt'],A,B,C,D,x0,'c')</literal>
-            and this specific list may be created by the function <literal>syslin</literal>.
+            linear system <literal>[A,B,C,D]</literal> is represented by the <literal>tlist</literal>
+            <code>Sys=tlist(['lss';'A';'B';'C';'D';'X0';'dt'],A,B,C,D,x0,'c')</code>
+            and this specific list may be created by the function <function>syslin</function>.
         </para>
         <para>
-            Sys(2), Sys('A') or Sys.A is the state-matrix and Sys('dt') or Sys.dt is the time domain
+            <code>Sys(2)</code>, <code>Sys('A')</code> or <code>Sys.A</code> is the state-matrix and <code>Sys('dt')</code> or <code>Sys.dt</code> is the time domain.
         </para>
         <para>
             A rational matrix <literal>H</literal> is represented by the <literal>typed-list</literal>
-            <literal>H=rlist(Num,Den,[])</literal> where <literal>Num</literal> and <literal>Den</literal> are two
-            polynomial matrices and a  (e.g. continuous time) linear system with
-            transfer matrix <literal>H</literal> maybe created by <literal>syslin('c',H)</literal>.
+            <code>H=rlist(Num,Den,[])</code> where <literal>Num</literal> and <literal>Den</literal> are two
+            polynomial matrices and a continuous time linear system with
+            transfer matrix <literal>H</literal> may be created by <code>syslin('c',H)</code>.
         </para>
         <para>
-            H(2), H('num') or H.num is the transfer matrix numerator
+            <code>H(2)</code>, <code>H('num')</code> or <code>H.num</code> is the transfer matrix numerator.
         </para>
     </refsection>
     <refsection>
@@ -111,32 +114,32 @@ t.field1(2) = 20;
 t.field2(1) = "Scilab";
 t.field2(2) = "tlist";
 t.field2(3) = "example";
-
 // Fields contents display
 disp(t.field1)
 disp(t.field2)
-
 // Generic tlist display
 disp(t)
-
 // Overloading display for this type of tlist
 function %listtype_p(mytlist)
   f = fieldnames(mytlist);
-
   // typeof(mytlist) <=> f(1)
   mprintf("Displaying a tlist of type: %s\n", typeof(mytlist));
-
   mprintf("\n");
-
   mprintf("-- Field ''%s'' --\n", f(1));
   mprintf("Contents: %s\n", sci2exp(mytlist(f(1))));
-
   mprintf("\n");
-
   mprintf("-- Field ''%s'' --\n", f(2));
   mprintf("Contents: %s\n", sci2exp(mytlist(f(2))));
 endfunction
-
 // Display using overloading function
 disp(t)
  ]]></programlisting>
index cedc0c1..a61b88d 100644 (file)
@@ -2,7 +2,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="type">
     <refnamediv>
         <refname>type</refname>
-        <refpurpose>Returns the type of a variable</refpurpose>
+        <refpurpose>returns the type of a variable</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
             <varlistentry>
                 <term>x</term>
                 <listitem>
-                    <para>Scilab object</para>
+                    <para>a Scilab object.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>i</term>
                 <listitem>
-                    <para>integer</para>
+                    <para>an integer.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>type(x)</literal>  returns an integer which is the type of <literal>x</literal> as following:
+            <code>type(x)</code>  returns an integer which is the type of <varname>x</varname> as following:
         </para>
         <variablelist>
             <varlistentry>
                 <term>1</term>
                 <listitem>
-                    <para>real or complex matrix of double.</para>
+                    <para>a real or complex matrix of double.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>2</term>
                 <listitem>
                     <para>
-                        <link linkend="poly">polynomial matrix</link>.
+                        a <link linkend="poly">polynomial matrix</link>.
                     </para>
                 </listitem>
             </varlistentry>
@@ -49,7 +49,7 @@
                 <term>4</term>
                 <listitem>
                     <para>
-                        <link linkend="matrices">boolean matrix</link>.
+                        a <link linkend="matrices">boolean matrix</link>.
                     </para>
                 </listitem>
             </varlistentry>
@@ -57,7 +57,7 @@
                 <term>5</term>
                 <listitem>
                     <para>
-                        <link linkend="sparse">sparse matrix</link>.
+                        a <link linkend="sparse">sparse matrix</link>.
                     </para>
                 </listitem>
             </varlistentry>
@@ -65,7 +65,7 @@
                 <term>6</term>
                 <listitem>
                     <para>
-                        <link linkend="sparse">sparse boolean matrix</link>.
+                        a <link linkend="sparse">sparse boolean matrix</link>.
                     </para>
                 </listitem>
             </varlistentry>
@@ -79,7 +79,7 @@
                 <term>8</term>
                 <listitem>
                     <para>
-                        matrix of <link linkend="int8">integers</link> stored on 1 (int8), 2 (int16) or 4 (int32) bytes.
+                        a matrix of <link linkend="int8">integers</link> stored on 1 (<literal>int8</literal>), 2 (<literal>int16</literal>) or 4 (<literal>int32</literal>) bytes.
                     </para>
                 </listitem>
             </varlistentry>
@@ -87,7 +87,7 @@
                 <term>9</term>
                 <listitem>
                     <para>
-                        matrix of <link linkend="graphics_entities">graphic handles</link>.
+                        a matrix of <link linkend="graphics_entities">graphic handles</link>.
                     </para>
                 </listitem>
             </varlistentry>
@@ -95,7 +95,7 @@
                 <term>10</term>
                 <listitem>
                     <para>
-                        matrix of <link linkend="strings">character strings</link>.
+                        a matrix of <link linkend="strings">character strings</link>.
                     </para>
                 </listitem>
             </varlistentry>
                 <term>11</term>
                 <listitem>
                     <para>
-                        un-compiled function (Scilab code). Function created with <link linkend="deff">deff</link> with argument 'n'.
+                        an un-compiled function (Scilab code). A function created with <link linkend="deff">deff</link> with argument <literal>'n'</literal>.
                     </para>
                 </listitem>
             </varlistentry>
                 <term>13</term>
                 <listitem>
                     <para>
-                        compiled <link linkend="function">function</link> (Scilab code).
+                        a compiled <link linkend="function">function</link> (Scilab code).
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>14</term>
                 <listitem>
-                    <para>function library.</para>
+                    <para>a function <link linkend="library">library</link>.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>15</term>
                 <listitem>
                     <para>
-                        <link linkend="list">list</link>.
+                        a <link linkend="list">list</link>.
                     </para>
                 </listitem>
             </varlistentry>
                 <term>16</term>
                 <listitem>
                     <para>
-                        typed list (<link linkend="tlist">tlist</link>).
+                        a typed list (<link linkend="tlist">tlist</link>).
                     </para>
                 </listitem>
             </varlistentry>
                 <term>17</term>
                 <listitem>
                     <para>
-                        matrix oriented typed list (<link linkend="mlist">mlist</link>).
+                        a matrix oriented typed list (<link linkend="mlist">mlist</link>).
                     </para>
                 </listitem>
             </varlistentry>
                 <term>128</term>
                 <listitem>
                     <para>
-                        pointer (Use case: <link linkend="lufact">lufact</link>).
+                        a pointer (Use case: <link linkend="lufact">lufact</link>).
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>129</term>
                 <listitem>
-                    <para>size implicit polynomial used for indexing.</para>
+                    <para>a size implicit polynomial used for indexing.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>130</term>
                 <listitem>
-                    <para>built-in Scilab function, called also gateway (C,
-                        C++ or Fortran code).
+                    <para>
+                      a built-in Scilab function, called also <emphasis role="italic">gateway</emphasis> (C, C++ or Fortran code).
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>0</term>
                 <listitem>
-                    <para>null variable. It is mainly used internally by
+                    <para>a null variable. It is mainly used internally by
                         Scilab. If a function has no declared returned argument
-                        like <literal>disp</literal> when it is called it returns
+                        like <function>disp</function> when it is called it returns
                         a null variable. If a function is called with an omitted
                         argument in the argument list like
-                        <literal>foo(a,,b)</literal> the missing argument is
+                        <code>foo(a,,b)</code> the missing argument is
                         assigned to a null variable.
                     </para>
                     <para>
-                        Note that is a null variable is assigned to a name, it is removed.
-                        <literal>x=disp(1)</literal> deletes <literal>x</literal> 
+                      <note>
+                        Note that if a null variable is assigned to a name, it is removed.
+                        <code>x=disp(1)</code> deletes <literal>x</literal>.
+                      </note>
                     </para>
                 </listitem>
             </varlistentry>
         </variablelist>
-        <para>Please note that, for some variables, type will return tlist
-            or mlist due to the internal data structure. This is the case of
-            <emphasis role="italic">rational</emphasis>, <emphasis role="italic">state-space</emphasis>, <emphasis role="italic">hypermat</emphasis> and <emphasis role="italic">struct</emphasis>. Please considering the use of
+        <para>
+          <note>
+            Please note that, for some variables, <function>type</function> will return <literal>tlist</literal>
+            or <literal>mlist</literal> due to the internal data structure. This is the case of
+            <emphasis role="italic">rational</emphasis> and <emphasis role="italic">state-space</emphasis> matrices, <emphasis role="italic">hypermat</emphasis> and <emphasis role="italic">struct</emphasis>. Please considering the use of
             <link linkend="typeof">typeof</link> instead.
+          </note>
         </para>
     </refsection>
     <refsection role="see also">
index 167a894..5fb21a9 100644 (file)
@@ -2,12 +2,12 @@
 <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="typename">
     <refnamediv>
         <refname>typename</refname>
-        <refpurpose> associates a name to variable type</refpurpose>
+        <refpurpose>associates a name to variable type</refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
         <synopsis>[types [ [,names]]=typename()
-            typename(name,type)
+            typename(name, type)
         </synopsis>
     </refsynopsisdiv>
     <refsection>
             <varlistentry>
                 <term>types</term>
                 <listitem>
-                    <para>integer column vector: the types codes of each defined data types.</para>
+                    <para>an integer column vector: the types codes of each defined data types.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>names</term>
                 <listitem>
-                    <para>column vector of strings: the names associated to type codes.</para>
+                    <para>a column vector of strings: the names associated to type codes.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>type</term>
                 <listitem>
-                    <para>integer: the type code of new data type.</para>
+                    <para>an integer: the type code of new data type.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>name</term>
                 <listitem>
-                    <para>string: the name associated to the type code</para>
+                    <para>a string: the name associated to the type code.</para>
                 </listitem>
             </varlistentry>
         </variablelist>
         <para>
             The function and operator overloading make use of a formal name
             associated to data types to form the name of the overloading function
-            (see overloading). The <literal>typename</literal> can be used to handle this
+            (see <link linkend="overloading">overloading</link>). The <function>typename</function> can be used to handle this
             formal names for hard coded data types (the <literal>tlist</literal> or <literal>mlist</literal>
-            coded data types formal names are defined in an other way, see <literal>overloading</literal>).
+            coded data types formal names are defined in an other way, see <link linkend="overloading">overloading</link>).
         </para>
         <para>
-            Called without right hand side argument, <literal>typename</literal> returns
+            Called without right hand side argument, <function>typename</function> returns
             information on defined data types.
         </para>
         <para>
-            Called with right hand side argument, <literal>typename</literal> associates a name
+            Called with right hand side argument, <function>typename</function> associates a name
             to a data type code.
         </para>
         <para>
-            <literal>typename('',type)</literal> suppress the data type given by its code
+            <code>typename('',type)</code> suppress the data type given by its code
             <literal>type</literal> out of the table of known data types.
         </para>
         <para>Number max. of defined types is 50.</para>
index a6861cf..d93e2db 100644 (file)
             <varlistentry>
                 <term>object</term>
                 <listitem>
-                    <para>Scilab object</para>
+                    <para>a Scilab object</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>t</term>
                 <listitem>
-                    <para>string</para>
+                    <para>a string</para>
                 </listitem>
             </varlistentry>
         </variablelist>
     <refsection>
         <title>Description</title>
         <para>
-            <literal>t=typeof(object)</literal> returns one of the following
+            <literal>t=typeof(object)</code> returns one of the following
             strings:
         </para>
         <variablelist>
             <varlistentry>
                 <term>"constant"</term>
                 <listitem>
-                    <para>if object is a real or complex matrix of double.</para>
+                    <para>if <varname>object</varname> is a real or complex matrix of double.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>"polynomial"</term>
                 <listitem>
                     <para>
-                        if object is a <link linkend="poly">polynomial matrix</link>.
+                        if <varname>object</varname> is a <link linkend="poly">polynomial matrix</link>.
                     </para>
                 </listitem>
             </varlistentry>
@@ -61,7 +61,7 @@
                 <term>"function"</term>
                 <listitem>
                     <para>
-                        if object is a <link linkend="function">function</link> (Scilab code). See also <link linkend="deff">deff</link>.
+                        if <varname>object</varname> is a <link linkend="function">function</link> (Scilab code). See also <link linkend="deff">deff</link>.
                     </para>
                 </listitem>
             </varlistentry>
@@ -69,7 +69,7 @@
                 <term>"handle"</term>
                 <listitem>
                     <para>
-                        if object is an <link linkend="graphics_entities">handle</link>.
+                        if <varname>object</varname> is an <link linkend="graphics_entities">handle</link>.
                     </para>
                 </listitem>
             </varlistentry>
@@ -77,7 +77,7 @@
                 <term>"string"</term>
                 <listitem>
                     <para>
-                        if object is a matrix made of <link linkend="strings">character strings</link>.
+                        if <varname>object</varname> is a matrix made of <link linkend="strings">character strings</link>.
                     </para>
                 </listitem>
             </varlistentry>
@@ -85,7 +85,7 @@
                 <term>"boolean"</term>
                 <listitem>
                     <para>
-                        if object is a <link linkend="matrices">boolean matrix</link>.
+                        if <varname>object</varname> is a <link linkend="matrices">boolean matrix</link>.
                     </para>
                 </listitem>
             </varlistentry>
@@ -93,7 +93,7 @@
                 <term>"list"</term>
                 <listitem>
                     <para>
-                        if object is a <link linkend="list">list</link>.
+                        if <varname>object</varname> is a <link linkend="list">list</link>.
                     </para>
                 </listitem>
             </varlistentry>
                 <term>"rational"</term>
                 <listitem>
                     <para>
-                        if object is a <link linkend="rational">rational matrix</link> (transfer matrix).
+                        if <varname>object</varname> is a <link linkend="rational">rational matrix</link> (transfer matrix).
                     </para>
                 </listitem>
             </varlistentry>
                 <term>"state-space"</term>
                 <listitem>
                     <para>
-                        if object is a state-space model (see <link linkend="syslin">syslin</link>).
+                        if <varname>object</varname> is a state-space model (see <link linkend="syslin">syslin</link>).
                     </para>
                 </listitem>
             </varlistentry>
                 <term>"sparse"</term>
                 <listitem>
                     <para>
-                        if object is a (real) <link linkend="sparse">sparse matrix</link>.
+                        if <varname>object</varname> is a (real) <link linkend="sparse">sparse matrix</link>.
                     </para>
                 </listitem>
             </varlistentry>
                 <term>"boolean sparse"</term>
                 <listitem>
                     <para>
-                        if object is a <link linkend="sparse">boolean sparse matrix</link>.
+                        if <varname>object</varname> is a <link linkend="sparse">boolean sparse matrix</link>.
                     </para>
                 </listitem>
             </varlistentry>
                 <term>"hypermat"</term>
                 <listitem>
                     <para>
-                        if object is an <link linkend="hypermatrices">hypermatrix</link> (N-dimension array with N
-                        &gt;=3).
+                      if <varname>object</varname> is a <link linkend="hypermatrices">hypermatrix</link> (<litera>N</literal>-dimension array with <litera><![CDATA[N<=3]]></litera>.
                     </para>
                 </listitem>
             </varlistentry>
                 <term>"st"</term>
                 <listitem>
                     <para>
-                        if object is a <link linkend="struct">structure</link>.
+                        if <varname>object</varname> is a <link linkend="struct">structure</link>.
                     </para>
                 </listitem>
             </varlistentry>
                 <term>"ce"</term>
                 <listitem>
                     <para>
-                        if object is a <link linkend="cell">cell</link> array.
+                        if <varname>object</varname> is a <link linkend="cell">cell</link> array.
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>"fptr"</term>
                 <listitem>
-                    <para>if object is a built-in Scilab function, called also gateway (C, C++ or Fortran code).</para>
+                    <para>if <varname>object</varname> is a built-in Scilab function, called also <emphasis role="italic">gateway</emphasis> (C, C++ or Fortran code).</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>"pointer"</term>
                 <listitem>
                     <para>
-                        if object is a pointer (See a use case: <link linkend="lufact">lufact</link>).
+                        if <varname>object</varname> is a pointer (See an use case: <link linkend="lufact">lufact</link>).
                     </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>"size implicit"</term>
                 <listitem>
-                    <para>if object is a size implicit polynomial used for indexing. This a purely internal value.</para>
+                    <para>if <varname>object</varname> is a size implicit polynomial used for indexing. This a purely internal value.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>"library"</term>
                 <listitem>
-                    <para>if object is function library.</para>
+                    <para>if <varname>object</varname> is a function <link linkend="library">library</link>.</para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>"int8" or "uint8" or "int16" or "uint16" or "int32" or "uint32"</term>
                 <listitem>
                     <para>
-                        if object is a matrix of [unsigned] integers stored on 8, 16 or 32 bits. (See <link linkend="int8">int</link>)
+                        if <varname>object</varname> is a matrix of [unsigned] integers stored on 8, 16 or 32 bits. (See <link linkend="int8">int</link>)
                     </para>
                 </listitem>
             </varlistentry>
         </variablelist>
         <para>
-            Note that if the object is a <link linkend="tlist">tlist</link> or <link linkend="mlist">mlist</link>, typeof will return the first string in the first list entry
+          <note>
+            Note that if the <varname>object</varname> is a <link linkend="tlist">tlist</link> or <link linkend="mlist">mlist</link>, <function>typeof</function> will return the first string in the first list entry.
+          </note>
         </para>
     </refsection>
     <refsection>
         <programlisting role="example"><![CDATA[ 
 typeof(1)
 typeof(poly(0,'x'))
-
 typeof(1/poly(0,'x'))
 typeof(%t)
-
 w=sprand(100,100,0.001);
 typeof(w)
 typeof(w==w)
-
 deff('y=f(x)','y=2*x');
 typeof(f)
-
 L=tlist(['V','a','b'],18,'Scilab');
 typeof(L)
-
 typeof(corelib)
  ]]></programlisting>
     </refsection>
index dcbd32e..986f26b 100644 (file)
@@ -1,79 +1,81 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2007-2008 - 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="ru" xml:id="boolean">
-    <refnamediv>
-        <refname>boolean</refname>
-        <refpurpose>Объекты Scilab, логические переменные и операторы &amp; | ~  </refpurpose>
-    </refnamediv>
-    <refsection>
-        <title>Описание</title>
-        <para>
-            Логическими переменными являются <literal>%T</literal> для "истины" (англ. "true") и
-            <literal>%F</literal> для "лжи" (англ. "false").
-            Эти переменные могут использоваться для определения матриц логических значений с 
-            помощью обычного синтаксиса. С матрицами логических значений можно обращаться как с 
-            обычными матрицами для выделения/вставки элементов и конкатенации. Заметим, 
-            что другие обычные операции(<literal>+, *, -, ^,</literal> и т. д.) не определены для 
-            матриц логических значений. Для матриц логических значений определены три специальных 
-            оператора:
-        </para>
-        <variablelist>
-            <varlistentry>
-                <term>~b</term>
-                <listitem>
-                    <para>
-                        поэлементное логическое НЕ матрицы <literal>b</literal>.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>b1&amp;b2</term>
-                <listitem>
-                    <para>
-                        поэлементное логическое И матриц <literal>b1</literal> и <literal>b2</literal>.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>b1|b2</term>
-                <listitem>
-                    <para>
-                        поэлементное логическое ИЛИ матриц <literal>b1</literal> и <literal>b2</literal>.
-                    </para>
-                </listitem>
-            </varlistentry>
-            <varlistentry>
-                <term>Логические переменные могут использоваться для индексации матриц и векторов.</term>
-                <listitem>
-                    <para>
-                        Например, <literal>a([%T,%F,%T],:)</literal> возвращает подматрицу, составленную из строк <literal>1</literal> и <literal>3</literal> матрицы <literal>a</literal>. Поддерживаются разрежённые логические матрицы.
-                    </para>
-                </listitem>
-            </varlistentry>
-        </variablelist>
-    </refsection>
-    <refsection>
-        <title>Примеры</title>
-        <programlisting role="example"><![CDATA[ 
+  <refnamediv>
+    <refname>boolean</refname>
+    <refpurpose>Объекты Scilab'а, логические переменные и операторы &amp; | ~
+    </refpurpose>
+  </refnamediv>
+  <refsection>
+    <title>Описание</title>
+    <para>
+      Логическими переменными являются <constant>%T</constant>, ИСТИНА (англ. "true"), и <constant>%F</constant>, ЛОЖЬ (англ. "false"). Эти переменные могут использоваться для определения матриц логических значений с помощью обычного синтаксиса. С матрицами логических значений можно обращаться как с обычными матрицами для выделения/вставки элементов и конкатенации. Заметим, что другие обычные операции(<literal>+</literal>, <literal>*</literal>, <literal>-</literal>, <literal>^</literal> и т. д.) не определены для матриц логических значений. Для матриц логических значений определены три специальных оператора:
+    </para>
+    <variablelist>
+      <varlistentry>
+       <term>~b</term>
+       <listitem>
+         <para>
+           поэлементное логическое НЕ матрицы <literal>b</literal>.
+         </para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
+       <term>b1 &amp; b2</term>
+       <listitem>
+         <para>
+           поэлементное логическое И матриц <literal>b1</literal> и <literal>b2</literal>.
+         </para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
+       <term>b1 | b2</term>
+       <listitem>
+         <para>
+           поэлементное логическое ИЛИ матриц <literal>b1</literal> и <literal>b2</literal>.
+         </para>
+       </listitem>
+      </varlistentry>
+    </variablelist>
+    <para>
+      Логические переменные могут использоваться для индексации матриц и векторов. Например, <code>a([%T, %F, %T],:)</code> возвращает подматрицу, составленную из строк <literal>1</literal> и <literal>3</literal> матрицы <literal>a</literal>. Поддерживаются разрежённые логические матрицы.
+    </para>
+  </refsection>
+  <refsection>
+    <title>Примеры</title>
+    <programlisting role="example"><![CDATA[
 [1,2]==[1,3]
 [1,2]==1
 a=1:5; a(a>2)
- ]]></programlisting>
-    </refsection>
-    <refsection role="see also">
-        <title>Смотрите также</title>
-        <simplelist type="inline">
-            <member>
-                <link linkend="matrices">matrices</link>
-            </member>
-            <member>
-                <link linkend="or">or</link>
-            </member>
-            <member>
-                <link linkend="and">and</link>
-            </member>
-            <member>
-                <link linkend="not">not</link>
-            </member>
-        </simplelist>
-    </refsection>
+]]></programlisting>
+  </refsection>
+  <refsection role="see also">
+    <title>Смотрите также</title>
+    <simplelist type="inline">
+      <member>
+       <link linkend="matrices">матрицы</link>
+      </member>
+      <member>
+       <link linkend="or">or</link>
+      </member>
+      <member>
+       <link linkend="and">and</link>
+      </member>
+      <member>
+       <link linkend="not">not</link>
+      </member>
+    </simplelist>
+  </refsection>
 </refentry>
\ No newline at end of file
index 1369d4a..48cc0cb 100644 (file)
@@ -7,8 +7,8 @@
     <refsection>
         <title>Описание</title>
         <para>
-            Matrices are basic objects defined in Scilab.
-            They can be defined as follows:
+            Матрицы являются основными объектами, определёнными в Scilab'е.
+            Они могут определяться следующим образом:
         </para>
         <programlisting role="no-scilab-exec"><![CDATA[ 
 E=[e11,e12,...,e1n;
@@ -59,3 +59,4 @@ E=['A11','A12';'A21','A22']
         </simplelist>
     </refsection>
 </refentry>
\ No newline at end of file
index c880d54..dc71238 100644 (file)
@@ -33,3 +33,4 @@ l(2)=null() // получить list(1,3)
         </simplelist>
     </refsection>
 </refentry>
\ No newline at end of file