remove functions declared obsolete for scilab 5.2
[scilab.git] / scilab / modules / graphic_export / help / en_US / xs2eps.xml
index b3eaf2d..dbacb7d 100644 (file)
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
-<MAN>
-  <LANGUAGE>eng</LANGUAGE>
-  <TITLE>xs2eps</TITLE>
-  <TYPE>Scilab Function</TYPE>
-  <DATE>$LastChangedDate: 2006-08-03 16:16:36 +0200 (jeu., 03 août 2006) $</DATE>
-  <SHORT_DESCRIPTION name="xs2eps">save graphics to a Postscript file.</SHORT_DESCRIPTION>
-  <CALLING_SEQUENCE>
-    <CALLING_SEQUENCE_ITEM>xs2eps(win_num,filen [,colored] [,orientation])</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>colored</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>: 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.</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-      <PARAM_ITEM>
-        <PARAM_NAME>orientation</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>: optional character, with possible values 'p' (portrait) or 'l' (landscape).
-          The default value  is 'p'.</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-    </PARAM_INDENT>
-  </PARAM>
-  <DESCRIPTION>
-    <P>The function xs2eps will not be available in version alpha</P>
-    <P><VERB>xs2eps</VERB> saves the recorded graphics of the window
-    <VERB>win_num</VERB> to file <VERB>filen</VERB> in Postscript syntax. 
-    Note that <VERB>filen</VERB> must not have extension.</P>
-
-    <P><VERB>xs2eps</VERB> produces a complete encapsulated Postscrip file. 
-    It simply  calls <VERB>xs2eps</VERB> and then <VERB>BEpsf</VERB>.</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[ 
-    scf(0)
-    plot2d()
-    // Postscript export
-    filename='foo'; // ! no extension
-    xs2eps(0,filename)
-  ]]></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>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>xs2pdf</LINK>
-    </SEE_ALSO_ITEM>
-       
-       <SEE_ALSO_ITEM>
-      <LINK>xs2svg</LINK>
-    </SEE_ALSO_ITEM>
-       
-       <SEE_ALSO_ITEM>
-      <LINK>xs2ps</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>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2008 - INRIA - Sylvestre Koumar
+ * 
+ * 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="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>send graphics to an EPS file.</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <title>Calling Sequence</title>
+
+    <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, id of the figure to export.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>fig</term>
+
+        <listitem>
+          <para>handle of the figure to export.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>file_name</term>
+
+        <listitem>
+          <para>string, name of the exported file.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>orientation</term>
+
+        <listitem>
+          <para>optional character, with possible values 'portrait' or
+          'landscape'. The default value is 'portrait'.</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsection>
+
+  <refsection>
+    <title>Description</title>
+
+    <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()
+//EPS export
+xs2eps(0,'foo.eps')
+xs2eps(gcf(),'foo.eps')
+ ]]></programlisting>
+  </refsection>
+
+  <refsection>
+    <title>See Also</title>
+
+    <simplelist type="inline">
+      <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>