remove functions declared obsolete for scilab 5.2
[scilab.git] / scilab / modules / graphic_export / help / en_US / xs2eps.xml
index 3d38c5a..dbacb7d 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) 2008 - INRIA - Sylvestre Koumar
  * 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="xs2eps">
+<refentry version="5.0-subset Scilab" xml:id="xs2eps" 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:ns4="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>xs2eps</refname>
-    <refpurpose>save graphics to a Postscript file.</refpurpose>
+
+    <refpurpose>send graphics to an EPS file.</refpurpose>
   </refnamediv>
+
   <refsynopsisdiv>
     <title>Calling Sequence</title>
-    <synopsis>xs2eps(win_num,filen [,colored] [,orientation])</synopsis>
+
+    <synopsis>xs2eps(win_num, file_name [,orientation])
+xs2eps(fig, file_name [,orientation])</synopsis>
   </refsynopsisdiv>
+
   <refsection>
     <title>Parameters</title>
+
     <variablelist>
       <varlistentry>
         <term>win_num</term>
+
         <listitem>
-          <para>integer scalar or vector .</para>
+          <para>integer, id of the figure to export.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
-        <term>filen</term>
+        <term>fig</term>
+
         <listitem>
-          <para>string, file name.</para>
+          <para>handle of the figure to export.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
-        <term>colored</term>
+        <term>file_name</term>
+
         <listitem>
-          <para>optional integer or boolean. 0 (%f) means black and white and 1
-           (%t) means color.
-          The default value (-1) is to use a value compatible with the screen
-          status.</para>
+          <para>string, name of the exported file.</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>
+          <para>optional character, with possible values 'portrait' or
+          'landscape'. The default value is 'portrait'.</para>
         </listitem>
       </varlistentry>
     </variablelist>
   </refsection>
+
   <refsection>
     <title>Description</title>
-    <para>The function xs2eps will not be available in version alpha</para>
-    <para><literal>xs2eps</literal> saves the recorded graphics of the window
-    <literal>win_num</literal> to file <literal>filen</literal> in Postscript syntax. 
-    Note that <literal>filen</literal> must not have extension.</para>
-    <para><literal>xs2eps</literal> produces a complete encapsulated Postscrip file. 
-    It simply  calls <literal>xs2eps</literal> and then <literal>BEpsf</literal>.</para>
-    <para>This function works only if the selected driver is <literal>"Rec"</literal>
-    in the window <literal>win_num</literal> or if the window is in "new style". The
-    generated postscript file does not contrains the header part</para>
+
+    <para><literal>xs2eps</literal> exports the display of a graphic window
+    into a complete Encapsulated PostScript file.</para>
   </refsection>
+
   <refsection>
     <title>Examples</title>
+
     <programlisting role="example"><![CDATA[ 
-    scf(0)
-    plot2d()
-    // Postscript export
-    filename='foo'; // ! no extension
-    xs2eps(0,filename)
-  ]]></programlisting>
+scf(0)
+plot2d()
+//EPS export
+xs2eps(0,'foo.eps')
+xs2eps(gcf(),'foo.eps')
+ ]]></programlisting>
   </refsection>
+
   <refsection>
     <title>See Also</title>
+
     <simplelist type="inline">
-      <member>
-        <link linkend="set_posfig_dim">set_posfig_dim</link>
-      </member>
-      <member>
-        <link linkend="printing">printing</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="xs2pdf">xs2pdf</link>
-      </member>
-      <member>
-        <link linkend="xs2svg">xs2svg</link>
-      </member>
-      <member>
-        <link linkend="xs2ps">xs2ps</link>
-      </member>
-      <member>
-        <link linkend="xs2fig">xs2fig</link>
-      </member>
-      <member>
-        <link linkend="xs2emf">xs2emf</link>
-      </member>
+      <member>figure_size property</member>
+
+      <member><link linkend="toprint">toprint</link></member>
+
+      <member><link linkend="printfigure">printfigure</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="xs2pdf">xs2pdf</link></member>
+
+      <member><link linkend="xs2svg">xs2svg</link></member>
+
+      <member><link linkend="xs2ps">xs2ps</link></member>
+
+      <member><link linkend="xs2fig">xs2fig</link></member>
+
+      <member><link linkend="xs2emf">xs2emf</link></member>
     </simplelist>
   </refsection>
 </refentry>