Fix some misc errors in the help
[scilab.git] / scilab / modules / m2sci / help / en_US / matfile2sci.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!--
3     * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4     * Copyright (C) ???? - INRIA - Serge STEER 
5     * 
6     * This file must be used under the terms of the CeCILL.
7     * This source file is licensed as described in the file COPYING, which
8     * you should have received as part of this distribution.  The terms
9     * are also available at    
10     * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11     *
12     -->
13 <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" version="5.0-subset Scilab" xml:lang="en" xml:id="matfile2sci">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>matfile2sci</refname>
19     <refpurpose> converts  a Matlab 5 MAT-file
20   into a Scilab binary file</refpurpose>
21   </refnamediv>
22   <refsynopsisdiv>
23     <title>Calling Sequence</title>
24     <synopsis>matfile2sci(mat_file_path,sci_file_path)</synopsis>
25   </refsynopsisdiv>
26   <refsection>
27     <title>Parameters</title>
28     <variablelist>
29       <varlistentry>
30         <term>mat_file_path</term>
31         <listitem>
32           <para>character string containing the path of the Matlab input file</para>
33         </listitem>
34       </varlistentry>
35       <varlistentry>
36         <term>sci_file_path</term>
37         <listitem>
38           <para>character string containing the path of the Scilab output file</para>
39         </listitem>
40       </varlistentry>
41     </variablelist>
42   </refsection>
43   <refsection>
44     <title>Description</title>
45     <para>
46     Converts a Matlab 5 MAT-file into a Scilab binary file compatible
47     with  the function <literal>load</literal> The Matlab data types are
48     converted into the Scilab equivalents.</para>
49   </refsection>
50   <refsection>
51     <title>See Also</title>
52     <simplelist type="inline">
53       <member>
54         <link linkend="loadmatfile">loadmatfile</link>
55       </member>
56       <member>
57         <link linkend="load">load</link>
58       </member>
59       <member>
60         <link linkend="mfile2sci">mfile2sci</link>
61       </member>
62     </simplelist>
63   </refsection>
64   <refsection>
65     <title>Authors</title>
66     <para>Serge Steer (INRIA)  </para>
67   </refsection>
68   <refsection>
69     <title>Bibliography</title>
70     <para>This function has been developped according to the document  "MAT-File Format":
71 ><ulink url="http://www.mathworks.com/access/helpdesk/help/pdf_doc/matlab/matfile_format.pdf">Mat-File Format</ulink></para>
72   </refsection>
73 </refentry>