typeof was refering to xmlobjects instead of XMLObjects
[scilab.git] / scilab / modules / data_structures / help / en_US / typeof.xml
index f3a389a..e84fd84 100644 (file)
@@ -13,7 +13,7 @@
  * along with this program.
  *
  -->
- <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="typeof" xml:lang="en">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="typeof" xml:lang="en">
     <refnamediv>
         <refname>typeof</refname>
         <refpurpose>Human-readable type or overloading code of an object</refpurpose>
@@ -21,9 +21,9 @@
     <refsynopsisdiv>
         <title>Syntax</title>
         <synopsis>
-          t  = typeof(object)
-          oc = typeof(object, "overload")
-      </synopsis>
+            t  = typeof(object)
+            oc = typeof(object, "overload")
+        </synopsis>
     </refsynopsisdiv>
     <refsection role="parameters">
         <title>Arguments</title>
             <varlistentry>
                 <term>t</term>
                 <listitem>
-                    <para>a string (may have spaces): the name of the type of <varname>object</varname>
-                  </para>
+                    <para>
+                        a string (may have spaces): the name of the type of <varname>object</varname>
+                    </para>
                 </listitem>
             </varlistentry>
             <varlistentry>
                 <term>oc</term>
                 <listitem>
                     <para>a string (without spaces): the name of the overloading code for the
-                      <varname>object</varname>.
-                  </para>
+                        <varname>object</varname>.
+                    </para>
                 </listitem>
             </varlistentry>
         </variablelist>
         </para>
         <table>
             <tr>
-                <td><emphasis role="bold">string</emphasis></td>
+                <td>
+                    <emphasis role="bold">string</emphasis>
+                </td>
                 <td>
                     <varname>object</varname> is a matrix or hypermatrix made of
-                        <link linkend="strings">characters</link> and texts.
+                    <link linkend="strings">characters</link> and texts.
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">boolean</emphasis></td>
+                <td>
+                    <emphasis role="bold">boolean</emphasis>
+                </td>
                 <td>
                     <varname>object</varname> is a
                     <link linkend="matrices">boolean matrix or hypermatrix</link>.
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">constant</emphasis></td>
+                <td>
+                    <emphasis role="bold">constant</emphasis>
+                </td>
                 <td>
                     <varname>object</varname> is matrix or hypermatrix of
                     decimal or complex numbers.
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">polynomial</emphasis></td>
+                <td>
+                    <emphasis role="bold">polynomial</emphasis>
+                </td>
                 <td>
                     <varname>object</varname> is a matrix or hypermatrix of
                     <link linkend="poly">polynomials</link>
-                      with decimal or complex coefficients.
+                    with decimal or complex coefficients.
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">rational</emphasis></td>
                 <td>
-                   <varname>object</varname> is a matrix or hypermatrix of
-                   <link linkend="rational">rational</link>
-                   fractions (e.g. transfer matrix), with decimal or complex coefficients.
+                    <emphasis role="bold">rational</emphasis>
+                </td>
+                <td>
+                    <varname>object</varname> is a matrix or hypermatrix of
+                    <link linkend="rational">rational</link>
+                    fractions (e.g. transfer matrix), with decimal or complex coefficients.
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">handle</emphasis></td>
+                <td>
+                    <emphasis role="bold">handle</emphasis>
+                </td>
                 <td>
                     <varname>object</varname> is a graphics
                     <link linkend="graphics_entities">handle</link>.
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">list</emphasis></td>
-                <td><varname>object</varname> is a <link linkend="list">list</link>.</td>
+                <td>
+                    <emphasis role="bold">list</emphasis>
+                </td>
+                <td>
+                    <varname>object</varname> is a <link linkend="list">list</link>.
+                </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">st</emphasis></td>
+                <td>
+                    <emphasis role="bold">st</emphasis>
+                </td>
                 <td>
                     <varname>object</varname> is a
                     <link linkend="struct">structure</link>
-                      or a nD-array of structures.
+                    or a nD-array of structures.
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">ce</emphasis></td>
+                <td>
+                    <emphasis role="bold">ce</emphasis>
+                </td>
                 <td>
                     <varname>object</varname> is a
                     <link linkend="cell">cell</link> or a nD-array of cells.
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">boolean sparse</emphasis></td>
+                <td>
+                    <emphasis role="bold">boolean sparse</emphasis>
+                </td>
                 <td>
                     <varname>object</varname> is a
                     <link linkend="sparse">boolean sparse matrix</link>.
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">sparse</emphasis></td>
+                <td>
+                    <emphasis role="bold">sparse</emphasis>
+                </td>
                 <td>
                     <varname>object</varname> is a
                     <link linkend="sparse">sparse matrix</link>
-                        of decimal or complex numbers.
+                    of decimal or complex numbers.
                     <warning>Sparse numerical hypermatrices are not supported.</warning>
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">"Matlab sparse"</emphasis></td>
+                <td>
+                    <emphasis role="bold">"Matlab sparse"</emphasis>
+                </td>
                 <td>
                     <varname>object</varname> is a Matlab-like-encoded sparse
                     matrix (see <link linkend="mtlb_sparse">mtlb_sparse()</link>).
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">fptr</emphasis></td>
+                <td>
+                    <emphasis role="bold">fptr</emphasis>
+                </td>
                 <td>
                     <varname>object</varname> is a built-in Scilab function,
                     called also <emphasis role="italic">gateway</emphasis>
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">function</emphasis></td>
+                <td>
+                    <emphasis role="bold">function</emphasis>
+                </td>
                 <td>
                     <varname>object</varname> is a <link linkend="function">function</link>
                     (Scilab code). See also <link linkend="deff">deff</link>.
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">library</emphasis></td>
+                <td>
+                    <emphasis role="bold">library</emphasis>
+                </td>
                 <td>
                     <varname>object</varname> is a
                     <link linkend="library">library</link>
-                      of functions in Scilab language.
+                    of functions in Scilab language.
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">pointer</emphasis></td>
+                <td>
+                    <emphasis role="bold">pointer</emphasis>
+                </td>
                 <td>
                     <varname>object</varname> is a pointer. See a use case:
                     <link linkend="lufact">lufact</link>.
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">implicitlist</emphasis></td>
+                <td>
+                    <emphasis role="bold">implicitlist</emphasis>
+                </td>
                 <td>
                     <varname>object</varname> is an implicit list using a
                     polynomial as formal index, for indexing.
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">listdelete</emphasis></td>
                 <td>
-                    is returned by <function>typeof(<literal>null()</literal>)</function>.
+                    <emphasis role="bold">listdelete</emphasis>
+                </td>
+                <td>
+                    is returned by 
+                    <function>
+                        typeof(<literal>null()</literal>)
+                    </function>
+                    .
                     See  <link linkend="null">null()</link>.
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">void</emphasis></td>
+                <td>
+                    <emphasis role="bold">void</emphasis>
+                </td>
                 <td>is the typeof undefined elements in lists.</td>
             </tr>
-            <tr><td colspan="2"></td></tr>
+            <tr>
+                <td colspan="2"></td>
+            </tr>
             <tr>
                 <td colspan="2">
-                <emphasis role="bold italic">Typed T-Lists or M-Lists:</emphasis>
+                    <emphasis role="bold italic">Typed T-Lists or M-Lists:</emphasis>
                 </td>
             </tr>
             <tr>
                     string in the first list entry.
                 </td>
             </tr>
-            <tr><td colspan="2"></td></tr>
+            <tr>
+                <td colspan="2"></td>
+            </tr>
             <tr>
                 <td colspan="2">
                     <emphasis role="bold italic">Reserved T-List or M-List types
-                    predefined in Scilab:</emphasis>
+                        predefined in Scilab:
+                    </emphasis>
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">dir</emphasis></td>
-                <td><varname>object</varname> is the result of a
+                <td>
+                    <emphasis role="bold">dir</emphasis>
+                </td>
+                <td>
+                    <varname>object</varname> is the result of a
                     <link linkend="dir">dir()</link>
                     instruction, with fields <literal>name</literal>, <literal>date</literal>,
                     <literal>bytes</literal>, and <literal>isdir</literal>.
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">state-space</emphasis></td>
-                <td><varname>object</varname> is a state-space model
-                        (see <link linkend="syslin">syslin</link>).
+                <td>
+                    <emphasis role="bold">state-space</emphasis>
+                </td>
+                <td>
+                    <varname>object</varname> is a state-space model
+                    (see <link linkend="syslin">syslin</link>).
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">XMLDoc</emphasis></td>
+                <td>
+                    <emphasis role="bold">XMLDoc</emphasis>
+                </td>
                 <td>
                     <varname>object</varname> is an XML Document created with
-                     <link linkend="xmlRead">xmlRead</link>,
-                     <link linkend="xmlReadStr">xmlReadStr</link>,
-                     <link linkend="htmlRead">htmlRead</link>, or
-                     <link linkend="htmlReadStr">htmlReadStr</link>.
-                     Additional XML typeof are defined.
+                    <link linkend="xmlRead">xmlRead</link>,
+                    <link linkend="xmlReadStr">xmlReadStr</link>,
+                    <link linkend="htmlRead">htmlRead</link>, or
+                    <link linkend="htmlReadStr">htmlReadStr</link>.
+                    Additional XML typeof are defined.
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">H5Object</emphasis></td>
-                <td><varname>object</varname> is the id of an HDF5 file opened
+                <td>
+                    <emphasis role="bold">H5Object</emphasis>
+                </td>
+                <td>
+                    <varname>object</varname> is the id of an HDF5 file opened
                     with <link linkend="h5open">h5open</link>.
                     Additional HDF5 typeof are defined:
                     See <link linkend="h5objects">HDF5 Objects</link>.
                 </td>
             </tr>
             <tr>
-                <td><emphasis role="bold">uitree</emphasis></td>
+                <td>
+                    <emphasis role="bold">uitree</emphasis>
+                </td>
                 <td>
                     <varname>object</varname> is a tree, a branch or a leaf as created with  a
-                     uitree feature. See for instance <link linkend="uiCreateNode">uiCreateNode</link>.
+                    uitree feature. See for instance <link linkend="uiCreateNode">uiCreateNode</link>.
                 </td>
             </tr>
         </table>
@@ -458,7 +521,7 @@ h5close(a)
                 <link linkend="dir">dir</link>
             </member>
             <member>
-                <link linkend="xmlobjects">XML Objects</link>
+                <link linkend="XMLObjects">XML Objects</link>
             </member>
             <member>
                 <link linkend="h5objects">HDF5 Objects</link>
@@ -471,24 +534,27 @@ h5close(a)
             <revision>
                 <revnumber>6.0</revnumber>
                 <revdescription>
-                <itemizedlist>
-                    <listitem>"overload" keyword added. </listitem>
-                    <listitem>typeof "uint64" and "int64" added. </listitem>
-                    <listitem>
-                        typeof "hypermat" removed. Hypermatrices of any homogeneous type are now
-                        natively supported.
-                    </listitem>
-                    <listitem>typeof "listdelete" and "void" added.</listitem>
-                    <listitem>
-                        typeof(:) was "constant" and becomes "implicitlist". typeof(1:$) was
-                        "size implicit" and become "implicitlist".
-                    </listitem>
-                    <listitem>
-                        The typeof of T-lists and M-lists were limited to 8 characters. They may
-                        be longer now.</listitem>
-                    <listitem>typeof "size implicit" renamed "implicitlist" (<literal>1:$</literal>)</listitem>
-                    <listitem>Help page reviewed.</listitem>
-                </itemizedlist>
+                    <itemizedlist>
+                        <listitem>"overload" keyword added. </listitem>
+                        <listitem>typeof "uint64" and "int64" added. </listitem>
+                        <listitem>
+                            typeof "hypermat" removed. Hypermatrices of any homogeneous type are now
+                            natively supported.
+                        </listitem>
+                        <listitem>typeof "listdelete" and "void" added.</listitem>
+                        <listitem>
+                            typeof(:) was "constant" and becomes "implicitlist". typeof(1:$) was
+                            "size implicit" and become "implicitlist".
+                        </listitem>
+                        <listitem>
+                            The typeof of T-lists and M-lists were limited to 8 characters. They may
+                            be longer now.
+                        </listitem>
+                        <listitem>
+                            typeof "size implicit" renamed "implicitlist" (<literal>1:$</literal>)
+                        </listitem>
+                        <listitem>Help page reviewed.</listitem>
+                    </itemizedlist>
                 </revdescription>
             </revision>
         </revhistory>