Fix some misc errors in the help
[scilab.git] / scilab / modules / fftw / help / en_US / fftw.xml
index 3df1cb0..d03e006 100644 (file)
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2007 - INRIA
  * 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" version="5.0-subset Scilab" xml:lang="en" xml:id="fftw">
+<refentry version="5.0-subset Scilab" xml:id="fftw" xml:lang="en"
+          xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:svg="http://www.w3.org/2000/svg"
+          xmlns:ns3="http://www.w3.org/1999/xhtml"
+          xmlns:mml="http://www.w3.org/1998/Math/MathML"
+          xmlns:db="http://docbook.org/ns/docbook">
   <info>
     <pubdate>October 2006</pubdate>
   </info>
+
   <refnamediv>
     <refname>fftw</refname>
+
     <refpurpose>fast fourier transform that use fftw library</refpurpose>
   </refnamediv>
+
   <refsynopsisdiv>
     <title>Calling Sequence</title>
+
     <synopsis>[y]=fftw(x)
 [y]=fftw(x,sign)
 [y]=fftw(x,sign,dim,incr)
 [y]=fftw(x,sign,[dim1 dim2 ...dimN],[incr1 incr2 ...incrN])</synopsis>
   </refsynopsisdiv>
+
   <refsection>
     <title>Parameters</title>
+
     <variablelist>
       <varlistentry>
         <term>y,x</term>
+
         <listitem>
-          <para>matrix/vector of real/complex data. Input/output data to be transformed.</para>
+          <para>matrix/vector of real/complex data. Input/output data to be
+          transformed.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>sign</term>
+
         <listitem>
           <para>Integer. 1 or -1. Set direct or inverse transform.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>dim</term>
+
         <listitem>
-          <para>integer. Set the dimension (the length) of the transform.</para>
+          <para>integer. Set the dimension (the length) of the
+          transform.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term>incr</term>
+
         <listitem>
           <para>integer. Set the stride (the span) of the transform.</para>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsection>
+
   <refsection>
     <title>Description</title>
-    <para>
-    This function realizes direct/inverse Discrete Fourier Transform (DFT) with the help of the FFTW library.
-    </para>
-    <para>
-    One can compute vector, 2D, M-D transform with this function.
-    </para>
-    <para>
-    For more details of fftw syntax see <link xlink:href="fft.htm"><literal>fft</literal></link> scilab function.
-    </para>
-    <para>
-    For more details about FFTW library see FFTW Web site :<link xlink:href="http://www.fftw.org"><literal> http://www.fftw.org </literal>.</link>
-    </para>
-    <para>
-    Remark : fftw function automaticaly stores his last parameters in memory to re-use it in a second time.
-    </para>
-    <para>
-    This results on a time computation improvement when consecutives calls (with same parameters) are used.
+
+    <para>This function realizes direct/inverse Discrete Fourier Transform
+    (DFT) with the help of the FFTW library.</para>
+
+    <para>One can compute vector, 2D, M-D transform with this function.</para>
+
+    <para>For more details of fftw syntax see <link linkend='fft'>fft</link> scilab function.</para> 
+
+    <para>For more details about FFTW library see FFTW Web site : <ulink url='http://www.fftw.org'>http://www.fftw.org</ulink>
     </para>
+
+    <para>Remark : fftw function automaticaly stores his last parameters in
+    memory to re-use it in a second time.</para>
+
+    <para>This results on a time computation improvement when consecutives
+    calls (with same parameters) are used.</para>
   </refsection>
+
   <refsection>
     <title>Examples</title>
-    <programlisting role="example"><![CDATA[
+
+    <programlisting role="example">
   
   //simple vector direct transform
   a = rand(50,1)+%i*rand(50,1);
   y = fftw(a,-1,[5 6 4],[1 5 30]);
   b = fftw(y,1,[5 6 4],[1 5 30]);
   
-  ]]></programlisting>
+  </programlisting>
   </refsection>
+
   <refsection>
     <title>See Also</title>
+
     <simplelist type="inline">
-      <member>
-        <link linkend="fftw_flags">fftw_flags</link>
-      </member>
-      <member>
-        <link linkend="get_fftw_wisdom">get_fftw_wisdom</link>
-      </member>
-      <member>
-        <link linkend="set_fftw_wisdom">set_fftw_wisdom</link>
-      </member>
-      <member>
-        <link linkend="fftw_forget_wisdom">fftw_forget_wisdom</link>
-      </member>
+      <member><link linkend="fftw_flags">fftw_flags</link></member>
+
+      <member><link linkend="get_fftw_wisdom">get_fftw_wisdom</link></member>
+
+      <member><link linkend="set_fftw_wisdom">set_fftw_wisdom</link></member>
+
+      <member><link
+      linkend="fftw_forget_wisdom">fftw_forget_wisdom</link></member>
     </simplelist>
   </refsection>
+
   <refsection>
     <title>Bibliography</title>
-    <para>
-    Matteo Frigo and Steven G. Johnson, "FFTW Manual fo version 3.1.2" June 2006. Available : http://www.fftw.org
-    </para>
+
+    <para>Matteo Frigo and Steven G. Johnson, "FFTW Manual fo version 3.1.2"
+    June 2006. Available : http://www.fftw.org</para>
   </refsection>
-</refentry>
+</refentry>
\ No newline at end of file