add CDATA + role in the graphics module
[scilab.git] / scilab / modules / graphics / help / en_US / set_posfig_dim.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) INRIA - Serge Steer
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <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">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>set_posfig_dim</refname>
19     <refpurpose>change defaut transformation for
20   exporting in postscript</refpurpose>
21   </refnamediv>
22   <refsynopsisdiv>
23     <title>Calling Sequence</title>
24     <synopsis>set_posfig_dim(w,h)
25 set_posfig_dim(0,0)</synopsis>
26   </refsynopsisdiv>
27   <refsection>
28     <title>Parameters</title>
29     <variablelist>
30       <varlistentry>
31         <term>w</term>
32         <listitem>
33           <para>graphic figure width, number of pixels</para>
34         </listitem>
35       </varlistentry>
36       <varlistentry>
37         <term>h</term>
38         <listitem>
39           <para>graphic figure height, number of pixels</para>
40         </listitem>
41       </varlistentry>
42     </variablelist>
43   </refsection>
44   <refsection>
45     <title>Description</title>
46     <para><literal>set_posfig_dim(w,h)</literal> set the coordinates transformation to
47     be used when exporting a graphic window in postscript. The graphic figure
48     zoomed with ratios <literal>w/&lt;graphic figure width&gt;</literal>
49     horizontally and <literal>h/&lt;graphic figure height&gt;</literal>
50     vertically.</para>
51     <para>This function is particularily useful when one wants an export a
52     graphic figure exactly as it is shown on the screen. For that
53     <literal>w</literal> and <literal>h</literal> has to be set respectively to
54     <literal>&lt;graphic figure width&gt;</literal> and 
55     <literal>&lt;graphic figure height&gt;</literal></para>
56     <para><literal>set_posfig_dim(0,0)</literal> resets the default values:
57     <literal>w=600</literal>, <literal>h=424</literal>.</para>
58         
59         <para>
60                 Function <literal>set_posfig_dim</literal> is obsolete and will be permanently removed in Scilab 5.2.
61                 In current version, set_posfig_dim has no influence on exported files.
62                 Their width and height instead match the exported figure <literal>axes_size</literal> property.
63         </para>
64   </refsection>
65   <refsection>
66     <title>Examples</title>
67     <programlisting role="example"><![CDATA[  
68 // make a figure with a specific shape
69 f=scf(0);f.figure_size=[800,300];
70 plot2d();
71 set_posfig_dim(f.figure_size(1),f.figure_size(2));
72 filename='foo.ps';
73 xs2ps(0,filename);
74  ]]></programlisting>
75   </refsection>
76   <refsection>
77     <title>See Also</title>
78     <simplelist type="inline">
79       <member>
80         <link linkend="xs2ps">xs2ps</link>
81       </member>
82     </simplelist>
83   </refsection>
84   <refsection>
85     <title>Authors</title>
86     <para>Serge Steer INRIA</para>
87   </refsection>
88 </refentry>