Fix some misc errors in the help
[scilab.git] / scilab / modules / fftw / help / en_US / fftw.xml
index 11eba9d..d03e006 100644 (file)
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
-<!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
-<MAN>
-  <LANGUAGE>eng</LANGUAGE>
-  <TITLE>fftw</TITLE>
-  <TYPE>Scilab Function</TYPE>
-  <DATE>October 2006</DATE>
-  <SHORT_DESCRIPTION name="fftw">fast fourier transform that use fftw library</SHORT_DESCRIPTION>
-  <CALLING_SEQUENCE>
-    <CALLING_SEQUENCE_ITEM>[y]=fftw(x)</CALLING_SEQUENCE_ITEM>
-    <CALLING_SEQUENCE_ITEM>[y]=fftw(x,sign)</CALLING_SEQUENCE_ITEM>
-    <CALLING_SEQUENCE_ITEM>[y]=fftw(x,sign,dim,incr)</CALLING_SEQUENCE_ITEM>
-    <CALLING_SEQUENCE_ITEM>[y]=fftw(x,sign,[dim1 dim2 ...dimN],[incr1 incr2 ...incrN])</CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
-  <PARAM>
-    <PARAM_INDENT>
-      <PARAM_ITEM>
-        <PARAM_NAME>y,x</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>: matrix/vector of real/complex data. Input/output data to be transformed.</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-      <PARAM_ITEM>
-        <PARAM_NAME>sign</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>: Integer. 1 or -1. Set direct or inverse transform.</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-      <PARAM_ITEM>
-        <PARAM_NAME>dim</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>: integer. Set the dimension (the length) of the transform.</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-      <PARAM_ITEM>
-        <PARAM_NAME>incr</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>: integer. Set the stride (the span) of the transform.</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-    </PARAM_INDENT>
-  </PARAM>
-  <DESCRIPTION>
-    <P>
-    This function realizes direct/inverse Discrete Fourier Transform (DFT) with the help of the FFTW library.
-    </P>
-    <P>
-    One can compute vector, 2D, M-D transform with this function.
-    </P>
-    <P>
-    For more details of fftw syntax see <A href='fft.htm'><VERB>fft</VERB></A> scilab function.
-    </P>
-    <P>
-    For more details about FFTW library see FFTW Web site :<A href='http://www.fftw.org'><VERB> http://www.fftw.org </VERB>.</A>
-    </P>
-    <P>
-    <SP>
-     Remark : fftw function automaticaly stores his last parameters in memory to re-use it in a second time.
-     </SP>
-     <SP>
-     This results on a time computation improvement when consecutives calls (with same parameters) are used.
-    </SP>
-    </P>
-  </DESCRIPTION>
-  <EXAMPLE>
-  <![CDATA[
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2007 - 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 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>
+        </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>
+        </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 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">
+  
   //simple vector direct transform
   a = rand(50,1)+%i*rand(50,1);
   y = fftw(a);
   //More efficient than old
   y = fftw(a,-1,[5 6 4],[1 5 30]);
   b = fftw(y,1,[5 6 4],[1 5 30]);
-  ]]>
-  </EXAMPLE>
-  <SEE_ALSO>
-    <SEE_ALSO_ITEM>
-      <A href='fftw_flags.htm'><VERB>fftw_flags</VERB></A>
-      <A href='get_fftw_wisdom.htm'><VERB>get_fftw_wisdom</VERB></A>
-      <A href='set_fftw_wisdom.htm'><VERB>set_fftw_wisdom</VERB></A>
-      <A href='fftw_forget_wisdom.htm'><VERB>fftw_forget_wisdom</VERB></A>
-    </SEE_ALSO_ITEM>
-  </SEE_ALSO>
-
-  <BIBLIO>
-    <P>
-    Matteo Frigo and Steven G. Johnson, &quot;FFTW Manual fo version 3.1.2&quot; June 2006. Available : http://www.fftw.org
-    </P>
-  </BIBLIO>
-
-</MAN>
+  
+  </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>
+    </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>
+  </refsection>
+</refentry>
\ No newline at end of file