bug 4852
[scilab.git] / scilab / modules / graphics / help / en_US / set_posfig_dim.xml
index ee17c00..5ca89a2 100644 (file)
@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) INRIA - Serge Steer
  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  *
  -->
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
-<MAN>
-  <LANGUAGE>eng</LANGUAGE>
-
-  <TITLE>set_posfig_dim</TITLE>
-
-  <TYPE>Scilab Function</TYPE>
-
-  <DATE>$LastChangedDate$</DATE>
-
-  <SHORT_DESCRIPTION name="set_posfig_dim">change defaut transformation for
-  exporting in postscript</SHORT_DESCRIPTION>
-
-  <CALLING_SEQUENCE>
-    <CALLING_SEQUENCE_ITEM>set_posfig_dim(w,h)</CALLING_SEQUENCE_ITEM>
-
-    <CALLING_SEQUENCE_ITEM>set_posfig_dim(0,0)</CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
-
-  <PARAM>
-    <PARAM_INDENT>
-      <PARAM_ITEM>
-        <PARAM_NAME>w</PARAM_NAME>
-
-        <PARAM_DESCRIPTION>
-          <SP>: graphic figure width, number of pixels</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-
-      <PARAM_ITEM>
-        <PARAM_NAME>h</PARAM_NAME>
-
-        <PARAM_DESCRIPTION>
-          <SP>: graphic figure height, number of pixels</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-    </PARAM_INDENT>
-  </PARAM>
-
-  <DESCRIPTION>
-    <P><VERB>set_posfig_dim(w,h)</VERB> set the coordinates transformation to
+<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="set_posfig_dim">
+  <info>
+    <pubdate>$LastChangedDate$</pubdate>
+  </info>
+  <refnamediv>
+    <refname>set_posfig_dim</refname>
+    <refpurpose>change defaut transformation for
+  exporting in postscript</refpurpose>
+  </refnamediv>
+  <refsynopsisdiv>
+    <title>Calling Sequence</title>
+    <synopsis>set_posfig_dim(w,h)
+set_posfig_dim(0,0)</synopsis>
+  </refsynopsisdiv>
+  <refsection>
+    <title>Parameters</title>
+    <variablelist>
+      <varlistentry>
+        <term>w</term>
+        <listitem>
+          <para>graphic figure width, number of pixels</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>h</term>
+        <listitem>
+          <para>graphic figure height, number of pixels</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsection>
+  <refsection>
+    <title>Description</title>
+    <para><literal>set_posfig_dim(w,h)</literal> set the coordinates transformation to
     be used when exporting a graphic window in postscript. The graphic figure
-    zoomed with ratios <VERB>w/&lt;graphic figure width&gt;</VERB>
-    horizontally and <VERB>h/&lt;graphic figure height&gt;</VERB>
-    vertically.</P>
-
-    <P>This function is particularily useful when one wants an export a
+    zoomed with ratios <literal>w/&lt;graphic figure width&gt;</literal>
+    horizontally and <literal>h/&lt;graphic figure height&gt;</literal>
+    vertically.</para>
+    <para>This function is particularily useful when one wants an export a
     graphic figure exactly as it is shown on the screen. For that
-    <VERB>w</VERB> and <VERB>h</VERB> has to be set respectively to
-    <VERB>&lt;graphic figure width&gt;</VERB> and 
-    <VERB>&lt;graphic figure height&gt;</VERB></P>
-
-    <P><VERB>set_posfig_dim(0,0)</VERB> resets the default values:
-    <VERB>w=600</VERB>, <VERB>h=424</VERB>.</P>
-  </DESCRIPTION>
-
-  <EXAMPLE><![CDATA[ 
-    // make a figure with a specific shape 
-    f=scf(0);f.figure_size=[800,300];
-    plot2d()
-    set_posfig_dim(f.figure_size(1),f.figure_size(2))
-    filename='foo'; // ! no extension
-    xs2ps(0,filename)
-    //add the Postscript file header and create <filename>.eps file
-    if MSDOS then
-      unix_s(pathconvert('""'+WSCI+'/bin/BEpsf'+'""',%f)+' -p ' +filename)
-    else
-      unix_s(pathconvert('SCI/bin/BEpsf',%f)+' -p ' +filename)
-    end
-    
-  ]]></EXAMPLE>
-
-  <SEE_ALSO>
-    <SEE_ALSO_ITEM>
-      <LINK>xs2ps</LINK>
-    </SEE_ALSO_ITEM>
-  </SEE_ALSO>
-
-  <AUTHOR>Serge Steer INRIA</AUTHOR>
-</MAN>
+    <literal>w</literal> and <literal>h</literal> has to be set respectively to
+    <literal>&lt;graphic figure width&gt;</literal> and 
+    <literal>&lt;graphic figure height&gt;</literal></para>
+    <para><literal>set_posfig_dim(0,0)</literal> resets the default values:
+    <literal>w=600</literal>, <literal>h=424</literal>.</para>
+       
+       <para>
+               Function <literal>set_posfig_dim</literal> is obsolete and will be permanently removed in Scilab 5.2.
+               In current version, set_posfig_dim has no influence on exported files.
+               Their width and height instead match the exported figure <literal>axes_size</literal> property.
+       </para>
+  </refsection>
+  <refsection>
+    <title>Examples</title>
+    <programlisting role="example"><![CDATA[  
+// make a figure with a specific shape
+f=scf(0);f.figure_size=[800,300];
+plot2d();
+set_posfig_dim(f.figure_size(1),f.figure_size(2));
+filename='foo.ps';
+xs2ps(0,filename);
+ ]]></programlisting>
+  </refsection>
+  <refsection>
+    <title>See Also</title>
+    <simplelist type="inline">
+      <member>
+        <link linkend="xs2ps">xs2ps</link>
+      </member>
+    </simplelist>
+  </refsection>
+  <refsection>
+    <title>Authors</title>
+    <para>Serge Steer INRIA</para>
+  </refsection>
+</refentry>