Fix XML syntax
[scilab.git] / scilab / modules / graphic_export / help / en_US / xs2pdf.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
3 <MAN>
4   <LANGUAGE>eng</LANGUAGE>
5   <TITLE>xs2pdf</TITLE>
6   <TYPE>Scilab Function</TYPE>
7   <DATE>$LastChangedDate$</DATE>
8   <SHORT_DESCRIPTION name="xs2pdf">save graphics to a Postscript file.</SHORT_DESCRIPTION>
9   <CALLING_SEQUENCE>
10     <CALLING_SEQUENCE_ITEM>xs2pdf(win_num,filen [,colored] [,orientation])</CALLING_SEQUENCE_ITEM>
11   </CALLING_SEQUENCE>
12   <PARAM>
13     <PARAM_INDENT>
14       <PARAM_ITEM>
15         <PARAM_NAME>win_num</PARAM_NAME>
16         <PARAM_DESCRIPTION>
17           <SP>: integer scalar or vector .</SP>
18         </PARAM_DESCRIPTION>
19       </PARAM_ITEM>
20       <PARAM_ITEM>
21         <PARAM_NAME>filen</PARAM_NAME>
22         <PARAM_DESCRIPTION>
23           <SP>: string, file name.</SP>
24         </PARAM_DESCRIPTION>
25       </PARAM_ITEM>
26       <PARAM_ITEM>
27         <PARAM_NAME>colored</PARAM_NAME>
28         <PARAM_DESCRIPTION>
29           <SP>: optional integer or boolean. 0 (%f) means black and white and 1
30             (%t) means color.
31           The default value (-1) is to use a value compatible with the screen
32           status.</SP>
33         </PARAM_DESCRIPTION>
34       </PARAM_ITEM>
35       <PARAM_ITEM>
36         <PARAM_NAME>orientation</PARAM_NAME>
37         <PARAM_DESCRIPTION>
38           <SP>: optional character, with possible values 'p' (portrait) or 'l' (landscape).
39           The default value  is 'p'.</SP>
40         </PARAM_DESCRIPTION>
41       </PARAM_ITEM>
42     </PARAM_INDENT>
43   </PARAM>
44   <DESCRIPTION>
45     <P>The function xs2pdf will not be available in version alpha</P>
46     <P><VERB>xs2pdf</VERB> saves the recorded graphics of the window
47     <VERB>win_num</VERB> to file <VERB>filen</VERB> in Postscript syntax. 
48     Note that <VERB>filen</VERB> must not have extension.</P>
49
50     <P><VERB>xs2pdf</VERB> produces a complete encapsulated Postscrip file. 
51     It simply  calls <VERB>xs2pdf</VERB> and then <VERB>BEpsf</VERB>.</P>
52
53     <P>This function works only if the selected driver is <VERB>"Rec"</VERB>
54     in the window <VERB>win_num</VERB> or if the window is in "new style". The
55     generated postscript file does not contrains the header part</P>
56   </DESCRIPTION>
57
58   <EXAMPLE><![CDATA[ 
59     scf(0)
60     plot2d()
61     // Postscript export
62     filename='foo'; // ! no extension
63     xs2pdf(0,filename)
64   ]]></EXAMPLE>
65
66   <SEE_ALSO>
67     <SEE_ALSO_ITEM>
68       <LINK>set_posfig_dim</LINK>
69     </SEE_ALSO_ITEM>
70     <SEE_ALSO_ITEM>
71       <LINK>printing</LINK>
72     </SEE_ALSO_ITEM>
73         
74         <SEE_ALSO_ITEM>
75       <LINK>xbasimp</LINK>
76     </SEE_ALSO_ITEM>
77         
78         <SEE_ALSO_ITEM>
79       <LINK>xs2bmp</LINK>
80         </SEE_ALSO_ITEM>
81         
82         <SEE_ALSO_ITEM>
83       <LINK>xs2gif</LINK>
84         </SEE_ALSO_ITEM>
85         
86         <SEE_ALSO_ITEM>
87       <LINK>xs2jpg</LINK>
88     </SEE_ALSO_ITEM>
89         
90         <SEE_ALSO_ITEM>
91       <LINK>xs2png</LINK>
92         </SEE_ALSO_ITEM>
93         
94         <SEE_ALSO_ITEM>
95       <LINK>xs2ppm</LINK>
96     </SEE_ALSO_ITEM>
97         
98         <SEE_ALSO_ITEM>
99       <LINK>xs2eps</LINK>
100     </SEE_ALSO_ITEM>
101         
102         <SEE_ALSO_ITEM>
103       <LINK>xs2svg</LINK>
104     </SEE_ALSO_ITEM>
105         
106         <SEE_ALSO_ITEM>
107       <LINK>xs2ps</LINK>
108     </SEE_ALSO_ITEM>
109   
110     <SEE_ALSO_ITEM>
111       <LINK>xs2fig</LINK>
112     </SEE_ALSO_ITEM>    
113
114     <SEE_ALSO_ITEM>
115       <LINK>xs2emf</LINK>
116     </SEE_ALSO_ITEM>
117   </SEE_ALSO>
118 </MAN>