remove functions declared obsolete for scilab 5.2
[scilab.git] / scilab / modules / graphic_export / help / en_US / xs2pdf.xml
index 3ee3d15..e193e93 100644 (file)
@@ -30,7 +30,8 @@
   <refsynopsisdiv>
     <title>Calling Sequence</title>
 
-    <synopsis>xs2pdf(win_num,filen [,orientation])</synopsis>
+    <synopsis>xs2pdf(win_num, file_name [,orientation])
+xs2pdf(fig, file_name [,orientation])</synopsis>
   </refsynopsisdiv>
 
   <refsection>
         <term>win_num</term>
 
         <listitem>
-          <para>integer scalar .</para>
+          <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>filen</term>
+        <term>file_name</term>
 
         <listitem>
-          <para>string, file name.</para>
+          <para>string, name of the exported file.</para>
         </listitem>
       </varlistentry>
 
@@ -57,8 +66,7 @@
         <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>
     <title>Description</title>
 
-    <para><literal>xs2pdf</literal> saves the recorded graphics of the window
-    <literal>win_num</literal> to file <literal>filen</literal> in PDF syntax.
-    Note that <literal>filen</literal> must not have extension.</para>
+    <para><literal>xs2pdf</literal> exports the display of a graphic window into an PDF file.</para>
   </refsection>
 
   <refsection>
     <title>Examples</title>
 
-    <programlisting role="example"> 
+    <programlisting role="example"><![CDATA[ 
 scf(0);
 plot2d();
 //PDF export
 filename='foo'; // ! no extension
 xs2pdf(0,filename);
-  </programlisting>
+xs2pdf(gcf(),filename);
+ ]]></programlisting>
   </refsection>
 
   <refsection>
     <title>See Also</title>
 
     <simplelist type="inline">
-      <member><link linkend="set_posfig_dim">set_posfig_dim</link></member>
+      <member>figure_size property</member>
 
       <member><link linkend="toprint">toprint</link></member>
 
@@ -115,4 +122,4 @@ xs2pdf(0,filename);
       <member><link linkend="xs2emf">xs2emf</link></member>
     </simplelist>
   </refsection>
-</refentry>
\ No newline at end of file
+</refentry>