Bug 3341 fixed
[scilab.git] / scilab / modules / graphic_export / help / en_US / xs2ps.xml
index 9f2563f..ffc05ef 100644 (file)
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-<!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
-<MAN>
-  <LANGUAGE>eng</LANGUAGE>
-
-  <TITLE>xs2ps</TITLE>
-
-  <TYPE>Scilab Function</TYPE>
-
-  <DATE>$LastChangedDate$</DATE>
-
-  <SHORT_DESCRIPTION name="xs2ps">send graphics to a file in PS
-  syntax</SHORT_DESCRIPTION>
-
-  <CALLING_SEQUENCE>
-    <CALLING_SEQUENCE_ITEM>xs2ps(win_num,filen,[color])</CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
-
-  <PARAM>
-    <PARAM_INDENT>
-      <PARAM_ITEM>
-        <PARAM_NAME>win_num</PARAM_NAME>
-
-        <PARAM_DESCRIPTION>
-          <SP>: integer scalar or vector .</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-
-      <PARAM_ITEM>
-        <PARAM_NAME>filen</PARAM_NAME>
-
-        <PARAM_DESCRIPTION>
-          <SP>: string, file name.</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-
-      <PARAM_ITEM>
-        <PARAM_NAME>color</PARAM_NAME>
-
-        <PARAM_DESCRIPTION>
-          <SP>: optional integer. 0 means black and white and 1 means color.
-          The default value is to use a value compatible with the screen
-          status.</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-    </PARAM_INDENT>
-  </PARAM>
-
-  <DESCRIPTION>
-       <P>The function xs2ps will not be available in version alpha</P>
-    <P><VERB>xs2ps</VERB> saves the recorded graphics of the window
-    <VERB>win_num</VERB> to file <VERB>filen</VERB> in Postscript syntax. The
-    <VERB>filen</VERB> must not have suffix extension.</P>
-
-    <P>Note that the generated Postscript file cannot be direcly printed since
-    it requires a header file. The Scilab command <VERB>BEpsf</VERB> or others
-    can be used to add a header file. The function <VERB>xs2eps</VERB> can be
-    used to directly produce an encapsulated Postscript file with an
-    header.</P>
-
-    <P>This function works only if the selected driver is <VERB>"Rec"</VERB>
-    in the window <VERB>win_num</VERB> or if the window is in "new style". The
-    generated postscript file does not contrains the header part</P>
-  </DESCRIPTION>
-
-<EXAMPLE><![CDATA[
+<refentry version="5.0-subset Scilab" xml:id="xs2ps" 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:ns5="http://www.w3.org/1999/xhtml"
+          xmlns:mml="http://www.w3.org/1998/Math/MathML"
+          xmlns:db="http://docbook.org/ns/docbook">
+  <info>
+    <pubdate>$LastChangedDate$</pubdate>
+  </info>
+
+  <refnamediv>
+    <refname>xs2ps</refname>
+
+    <refpurpose>send graphics to a file in PS syntax</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <title>Calling Sequence</title>
+
+    <synopsis>xs2ps(win_num,filen,[orientation])</synopsis>
+  </refsynopsisdiv>
+
+  <refsection>
+    <title>Parameters</title>
+
+    <variablelist>
+      <varlistentry>
+        <term>win_num</term>
+
+        <listitem>
+          <para>integer scalar or vector .</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>filen</term>
+
+        <listitem>
+          <para>string, file name.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>orientation</term>
+
+        <listitem>
+          <para>optional character, with possible values 'p' (portrait) or 'l'
+          (landscape). The default value is 'p'.</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsection>
+
+  <refsection>
+    <title>Description</title>
+
+    <para><literal>xs2ps</literal> saves the recorded graphics of the window
+    <literal>win_num</literal> to file <literal>filen</literal> in Postscript
+    syntax. The <literal>filen</literal> must not have suffix
+    extension.</para>
+
+    <para>Note that the generated Postscript file cannot be direcly printed
+    since it requires a header file. The function <literal>xs2eps</literal>
+    can be used to directly produce an encapsulated Postscript file with an
+    header.</para>
+  </refsection>
+
+  <refsection>
+    <title>Examples</title>
+
+    <programlisting role="example">
 scf(0);
 plot2d();
 // Postcript export
 filename='foo.ps';
-xs2ps(0,filename)
-// Gif export
-xs2gif(0,'foo.gif');
-// ppm export
-xs2ppm(0,'foo.ppm');
-]]></EXAMPLE>
-
-  <SEE_ALSO>
-    <SEE_ALSO_ITEM>
-      <LINK>set_posfig_dim</LINK>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <LINK>printing</LINK>
-    </SEE_ALSO_ITEM>
-       
-       <SEE_ALSO_ITEM>
-      <LINK>xbasimp</LINK>
-    </SEE_ALSO_ITEM>
-       
-       <SEE_ALSO_ITEM>
-      <LINK>xs2bmp</LINK>
-       </SEE_ALSO_ITEM>
-       
-       <SEE_ALSO_ITEM>
-      <LINK>xs2gif</LINK>
-       </SEE_ALSO_ITEM>
-       
-       <SEE_ALSO_ITEM>
-      <LINK>xs2jpg</LINK>
-    </SEE_ALSO_ITEM>
-       
-       <SEE_ALSO_ITEM>
-      <LINK>xs2png</LINK>
-       </SEE_ALSO_ITEM>
-       
-       <SEE_ALSO_ITEM>
-      <LINK>xs2ppm</LINK>
-    </SEE_ALSO_ITEM>
-       
-       <SEE_ALSO_ITEM>
-      <LINK>xs2eps</LINK>
-    </SEE_ALSO_ITEM>
-       
-       <SEE_ALSO_ITEM>
-      <LINK>xs2pdf</LINK>
-    </SEE_ALSO_ITEM>
-       
-       <SEE_ALSO_ITEM>
-      <LINK>xs2svg</LINK>
-    </SEE_ALSO_ITEM>
-  
-    <SEE_ALSO_ITEM>
-      <LINK>xs2fig</LINK>
-    </SEE_ALSO_ITEM>    
-
-    <SEE_ALSO_ITEM>
-      <LINK>xs2emf</LINK>
-    </SEE_ALSO_ITEM>
-  </SEE_ALSO>
-</MAN>
\ No newline at end of file
+xs2ps(0,filename);</programlisting>
+  </refsection>
+
+  <refsection>
+    <title>See Also</title>
+
+    <simplelist type="inline">
+      <member><link linkend="set_posfig_dim">set_posfig_dim</link></member>
+
+      <member><link linkend="toprint">toprint</link></member>
+
+      <member><link linkend="printfigure">printfigure</link></member>
+
+      <member><link linkend="xbasimp">xbasimp</link></member>
+
+      <member><link linkend="xs2bmp">xs2bmp</link></member>
+
+      <member><link linkend="xs2gif">xs2gif</link></member>
+
+      <member><link linkend="xs2jpg">xs2jpg</link></member>
+
+      <member><link linkend="xs2png">xs2png</link></member>
+
+      <member><link linkend="xs2ppm">xs2ppm</link></member>
+
+      <member><link linkend="xs2eps">xs2eps</link></member>
+
+      <member><link linkend="xs2pdf">xs2pdf</link></member>
+
+      <member><link linkend="xs2svg">xs2svg</link></member>
+
+      <member><link linkend="xs2fig">xs2fig</link></member>
+
+      <member><link linkend="xs2emf">xs2emf</link></member>
+    </simplelist>
+  </refsection>
+</refentry>
\ No newline at end of file