Fix the documentation. If the examples are the same, they should have the same syntax...
[scilab.git] / scilab / modules / graphics / help / en_US / Graphics.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
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" xmlns:scilab="http://www.scilab.org"  xml:lang="en" scilab:needs-examples="no" xml:id="Graphics">
14     <refnamediv>
15         <refname>Graphics: Getting started</refname>
16         <refpurpose>graphics library overview</refpurpose>
17     </refnamediv>
18     <refsection>
19         <title>2d plotting</title>
20         <variablelist>
21             <varlistentry>
22                 <term>
23                     <link linkend="plot2d">plot2d</link>
24                 </term>
25                 <listitem>
26                     <para>Plot a curve</para>
27                     <para>
28                         <emphasis role="bold">Example:</emphasis>
29                     </para>
30                     <para>
31                         <scilab:image>plot2d();</scilab:image>
32                     </para>
33                 </listitem>
34             </varlistentry>
35             <varlistentry>
36                 <term>
37                     <link linkend="plot2d2">plot2d2</link>
38                 </term>
39                 <listitem>
40                     <para>Plot a curve as step function</para>
41                     <para>
42                         <emphasis role="bold">Example:</emphasis>
43                     </para>
44                     <para>
45                         <scilab:image>plot2d2();</scilab:image>
46                     </para>
47                 </listitem>
48             </varlistentry>
49             <varlistentry>
50                 <term>
51                     <link linkend="plot2d3">plot2d3</link>
52                 </term>
53                 <listitem>
54                     <para>Plot a curve with vertical bars</para>
55                     <para>
56                         <emphasis role="bold">Example:</emphasis>
57                     </para>
58                     <para>
59                         <scilab:image>plot2d3();</scilab:image>
60                     </para>
61                 </listitem>
62             </varlistentry>
63             <varlistentry>
64                 <term>
65                     <link linkend="plot2d4">plot2d4</link>
66                 </term>
67                 <listitem>
68                     <para>Plot a curve with arrows</para>
69                     <para>
70                         <emphasis role="bold">Example:</emphasis>
71                     </para>
72                     <para>
73                         <scilab:image>plot2d4();</scilab:image>
74                     </para>
75                 </listitem>
76             </varlistentry>
77             <varlistentry>
78                 <term>
79                     <link linkend="fplot2d">fplot2d</link>
80                 </term>
81                 <listitem>
82                     <para>Plot a curve defined by a function</para>
83                     <para>
84                         <emphasis role="bold">Example:</emphasis>
85                     </para>
86                     <para>
87                         <scilab:image>fplot2d();</scilab:image>
88                     </para>
89                 </listitem>
90             </varlistentry>
91             <varlistentry>
92                 <term>
93                     <link linkend="champ">champ</link>
94                 </term>
95                 <listitem>
96                     <para>2D vector field</para>
97                     <para>
98                         <emphasis role="bold">Example:</emphasis>
99                     </para>
100                     <para>
101                         <scilab:image>champ();</scilab:image>
102                     </para>
103                 </listitem>
104             </varlistentry>
105             <varlistentry>
106                 <term>
107                     <link linkend="champ1">champ1</link>
108                 </term>
109                 <listitem>
110                     <para>2D vector field with colored arrows</para>
111                     <para>
112                         <emphasis role="bold">Example:</emphasis>
113                     </para>
114                     <para>
115                         <scilab:image>champ1();</scilab:image>
116                     </para>
117                 </listitem>
118             </varlistentry>
119             <varlistentry>
120                 <term>
121                     <link linkend="fchamp">fchamp</link>
122                 </term>
123                 <listitem>
124                     <para>Direction field of a 2D first order ODE</para>
125                     <para>
126                         <emphasis role="bold">Example:</emphasis>
127                     </para>
128                     <para>
129                         <scilab:image>fchamp();</scilab:image>
130                     </para>
131                 </listitem>
132             </varlistentry>
133             <varlistentry>
134                 <term>
135                     <link linkend="contour2d">contour2d</link>
136                 </term>
137                 <listitem>
138                     <para>Level curves of a surface on a 2D plot</para>
139                 </listitem>
140             </varlistentry>
141             <varlistentry>
142                 <term>
143                     <link linkend="fcontour2d">fcontour2d</link>
144                 </term>
145                 <listitem>
146                     <para>Level curves of a surface defined by a function on a 2D plot</para>
147                     <para>
148                         <emphasis role="bold">Example:</emphasis>
149                     </para>
150                     <para>
151                         <scilab:image>fcontour2d();</scilab:image>
152                     </para>
153                 </listitem>
154             </varlistentry>
155             <varlistentry>
156                 <term>
157                     <link linkend="grayplot">grayplot</link>
158                 </term>
159                 <listitem>
160                     <para>2D plot of a surface using colors</para>
161                     <para>
162                         <emphasis role="bold">Example:</emphasis>
163                     </para>
164                     <para>
165                         <scilab:image>grayplot();</scilab:image>
166                     </para>
167                 </listitem>
168             </varlistentry>
169             <varlistentry>
170                 <term>
171                     <link linkend="fgrayplot">fgrayplot</link>
172                 </term>
173                 <listitem>
174                     <para>2D plot of a surface defined by a function using colors</para>
175                     <para>
176                         <emphasis role="bold">Example:</emphasis>
177                     </para>
178                     <para>
179                         <scilab:image>fgrayplot();</scilab:image>
180                     </para>
181                 </listitem>
182             </varlistentry>
183             <varlistentry>
184                 <term>
185                     <link linkend="Sgrayplot">Sgrayplot</link>
186                 </term>
187                 <listitem>
188                     <para>Smooth 2D plot of a surface using colors</para>
189                     <para>
190                         <emphasis role="bold">Example:</emphasis>
191                     </para>
192                     <para>
193                         <scilab:image>Sgrayplot();</scilab:image>
194                     </para>
195                 </listitem>
196             </varlistentry>
197             <varlistentry>
198                 <term>
199                     <link linkend="Sfgrayplot">Sfgrayplot</link>
200                 </term>
201                 <listitem>
202                     <para>Smooth 2D plot of a surface defined by a function using colors</para>
203                     <para>
204                         <emphasis role="bold">Example:</emphasis>
205                     </para>
206                     <para>
207                         <scilab:image>Sfgrayplot();</scilab:image>
208                     </para>
209                 </listitem>
210             </varlistentry>
211             <varlistentry>
212                 <term>
213                     <link linkend="xgrid">xgrid</link>
214                 </term>
215                 <listitem>
216                     <para>Add a grid on a 2D plot</para>
217                     <para>
218                         <emphasis role="bold">Example:</emphasis>
219                     </para>
220                     <para>
221                         <scilab:image>x=[0:0.1:2*%pi]'; plot2d(sin(x));xgrid(5)</scilab:image>
222                     </para>
223                 </listitem>
224             </varlistentry>
225             <varlistentry>
226                 <term>
227                     <link linkend="errbar">errbar</link>
228                 </term>
229                 <listitem>
230                     <para>Add vertical error bars on a 2D plot</para>
231                     <para>
232                         <emphasis role="bold">Example:</emphasis>
233                     </para>
234                     <para>
235                         <scilab:image>errbar();</scilab:image>
236                     </para>
237                 </listitem>
238             </varlistentry>
239             <varlistentry>
240                 <term>
241                     <link linkend="histplot">histplot</link>
242                 </term>
243                 <listitem>
244                     <para>Plot a histogram</para>
245                     <para>
246                         <emphasis role="bold">Example:</emphasis>
247                     </para>
248                     <para>
249                         <scilab:image>histplot();</scilab:image>
250                     </para>
251                 </listitem>
252             </varlistentry>
253             <varlistentry>
254                 <term>
255                     <link linkend="Matplot">Matplot</link>
256                 </term>
257                 <listitem>
258                     <para>2D plot of a matrix using colors</para>
259                     <para>
260                         <emphasis role="bold">Example:</emphasis>
261                     </para>
262                     <para>
263                         <scilab:image>Matplot();</scilab:image>
264                     </para>
265                 </listitem>
266             </varlistentry>
267         </variablelist>
268     </refsection>
269     <refsection>
270         <title>3d plotting</title>
271         <variablelist>
272             <varlistentry>
273                 <term>
274                     <link linkend="plot3d">plot3d</link>
275                 </term>
276                 <listitem>
277                     <para>Plot a surface</para>
278                     <para>
279                         <emphasis role="bold">Example:</emphasis>
280                     </para>
281                     <para>
282                         <scilab:image>plot3d();</scilab:image>
283                     </para>
284                 </listitem>
285             </varlistentry>
286             <varlistentry>
287                 <term>
288                     <link linkend="plot3d1">plot3d1</link>
289                 </term>
290                 <listitem>
291                     <para>Plot a surface with gray or color level</para>
292                     <para>
293                         <emphasis role="bold">Example:</emphasis>
294                     </para>
295                     <para>
296                         <scilab:image>plot3d1();</scilab:image>
297                     </para>
298                 </listitem>
299             </varlistentry>
300             <varlistentry>
301                 <term>
302                     <link linkend="fplot3d">fplot3d</link>
303                 </term>
304                 <listitem>
305                     <para>Plot a surface defined by a function</para>
306                     <para>
307                         <emphasis role="bold">Example:</emphasis>
308                     </para>
309                     <para>
310                         <scilab:image>fplot3d();</scilab:image>
311                     </para>
312                 </listitem>
313             </varlistentry>
314             <varlistentry>
315                 <term>
316                     <link linkend="fplot3d1">fplot3d1</link>
317                 </term>
318                 <listitem>
319                     <para>Plot a surface defined by a function with gray or color level</para>
320                     <para>
321                         <emphasis role="bold">Example:</emphasis>
322                     </para>
323                     <para>
324                         <scilab:image>fplot3d1();</scilab:image>
325                     </para>
326                 </listitem>
327             </varlistentry>
328             <varlistentry>
329                 <term>
330                     <link linkend="param3d">param3d</link>
331                 </term>
332                 <listitem>
333                     <para>Plot one curve</para>
334                     <para>
335                         <emphasis role="bold">Example:</emphasis>
336                     </para>
337                     <para>
338                         <scilab:image>param3d();</scilab:image>
339                     </para>
340                 </listitem>
341             </varlistentry>
342             <varlistentry>
343                 <term>
344                     <link linkend="param3d1">param3d1</link>
345                 </term>
346                 <listitem>
347                     <para>Plots curves</para>
348                     <para>
349                         <emphasis role="bold">Example:</emphasis>
350                     </para>
351                     <para>
352                         <scilab:image>param3d1();</scilab:image>
353                     </para>
354                 </listitem>
355             </varlistentry>
356             <varlistentry>
357                 <term>
358                     <link linkend="contour">contour</link>
359                 </term>
360                 <listitem>
361                     <para>Level curves on a 3D surface</para>
362                     <para>
363                         <emphasis role="bold">Example:</emphasis>
364                     </para>
365                     <para>
366                         <scilab:image>contour();</scilab:image>
367                     </para>
368                 </listitem>
369             </varlistentry>
370             <varlistentry>
371                 <term>
372                     <link linkend="fcontour">fcontour</link>
373                 </term>
374                 <listitem>
375                     <para>Level curves on a 3D surface defined by a function</para>
376                     <para>
377                         <emphasis role="bold">Example:</emphasis>
378                     </para>
379                     <para>
380                         <scilab:image>fcontour();</scilab:image>
381                     </para>
382                 </listitem>
383             </varlistentry>
384             <varlistentry>
385                 <term>
386                     <link linkend="hist3d">hist3d</link>
387                 </term>
388                 <listitem>
389                     <para>3D representation of a histogram</para>
390                     <para>
391                         <emphasis role="bold">Example:</emphasis>
392                     </para>
393                     <para>
394                         <scilab:image>hist3d();</scilab:image>
395                     </para>
396                 </listitem>
397             </varlistentry>
398             <varlistentry>
399                 <term>
400                     <link linkend="genfac3d">genfac3d</link>
401                 </term>
402                 <listitem>
403                     <para>Compute facets of a 3D surface</para>
404                     <para>
405                         <emphasis role="bold">Example:</emphasis>
406                     </para>
407                     <para>
408                         <scilab:image>genfac3d();</scilab:image>
409                     </para>
410                 </listitem>
411             </varlistentry>
412             <varlistentry>
413                 <term>
414                     <link linkend="eval3dp">eval3dp</link>
415                 </term>
416                 <listitem>
417                     <para>Compute facets of a 3D surface</para>
418                     <para>
419                         <emphasis role="bold">Example:</emphasis>
420                     </para>
421                     <para>
422                         <scilab:image>p1=linspace(0,2*%pi,10);
423                             p2=linspace(0,2*%pi,10);
424                             deff("[x,y,z]=scp(p1,p2)",["x=p1.*sin(p1).*cos(p2)";..
425                             "y=p1.*cos(p1).*cos(p2)";..
426                             "z=p1.*sin(p2)"])
427                             [Xf,Yf,Zf]=eval3dp(scp,p1,p2);
428                             plot3d(Xf,Yf,Zf)
429                         </scilab:image>
430                     </para>
431                 </listitem>
432             </varlistentry>
433             <varlistentry>
434                 <term>
435                     <link linkend="geom3d">geom3d</link>
436                 </term>
437                 <listitem>
438                     <para>Projection from 3D on 2D after a 3D plot</para>
439                     <para>
440                         <emphasis role="bold">Example:</emphasis>
441                     </para>
442                     <para>
443                         <scilab:image>deff("[z]=surface(x,y)","z=sin(x)*cos(y)")
444                             t=%pi*(-10:10)/10;
445                             // 3D plot of the surface
446                             fplot3d(t,t,surface,35,45,"X@Y@Z")
447                             // now (t,t,sin(t).*cos(t)) is a curve on the surface
448                             // which can be drawn using geom3d and xpoly
449                             [x,y]=geom3d(%pi/2,0,surface(%pi/2,0))
450                         </scilab:image>
451                     </para>
452                 </listitem>
453             </varlistentry>
454         </variablelist>
455     </refsection>
456     <refsection>
457         <title>Line and polygon plotting</title>
458         <variablelist>
459             <varlistentry>
460                 <term>
461                     <link linkend="xpoly">xpoly</link>
462                 </term>
463                 <listitem>
464                     <para>Draw a polyline or a polygon</para>
465                 </listitem>
466             </varlistentry>
467             <varlistentry>
468                 <term>
469                     <link linkend="xpolys">xpolys</link>
470                 </term>
471                 <listitem>
472                     <para>Draw a set of polylines or polygons</para>
473                 </listitem>
474             </varlistentry>
475             <varlistentry>
476                 <term>
477                     <link linkend="xrpoly">xrpoly</link>
478                 </term>
479                 <listitem>
480                     <para>Draw a regular polygon</para>
481                 </listitem>
482             </varlistentry>
483             <varlistentry>
484                 <term>
485                     <link linkend="xsegs">xsegs</link>
486                 </term>
487                 <listitem>
488                     <para>Draw unconnected segments</para>
489                 </listitem>
490             </varlistentry>
491             <varlistentry>
492                 <term>
493                     <link linkend="xfpoly">xfpoly</link>
494                 </term>
495                 <listitem>
496                     <para>Fill a polygon</para>
497                 </listitem>
498             </varlistentry>
499             <varlistentry>
500                 <term>
501                     <link linkend="xfpolys">xfpolys</link>
502                 </term>
503                 <listitem>
504                     <para>Fill a set of polygons</para>
505                 </listitem>
506             </varlistentry>
507         </variablelist>
508     </refsection>
509     <refsection>
510         <title>Rectangle plotting</title>
511         <variablelist>
512             <varlistentry>
513                 <term>
514                     <link linkend="xrect">xrect</link>
515                 </term>
516                 <listitem>
517                     <para>Draw a rectangle</para>
518                 </listitem>
519             </varlistentry>
520             <varlistentry>
521                 <term>
522                     <link linkend="xfrect">xfrect</link>
523                 </term>
524                 <listitem>
525                     <para>Fill a rectangle</para>
526                 </listitem>
527             </varlistentry>
528             <varlistentry>
529                 <term>
530                     <link linkend="xrects">xrects</link>
531                 </term>
532                 <listitem>
533                     <para>Draw or fill a set of rectangles</para>
534                 </listitem>
535             </varlistentry>
536         </variablelist>
537     </refsection>
538     <refsection>
539         <title>Arc plotting</title>
540         <variablelist>
541             <varlistentry>
542                 <term>
543                     <link linkend="xarc">xarc</link>
544                 </term>
545                 <listitem>
546                     <para>Draw a part of an ellipse</para>
547                 </listitem>
548             </varlistentry>
549             <varlistentry>
550                 <term>
551                     <link linkend="xarcs">xarcs</link>
552                 </term>
553                 <listitem>
554                     <para>Draw parts of a set of ellipses</para>
555                 </listitem>
556             </varlistentry>
557             <varlistentry>
558                 <term>
559                     <link linkend="xfarc">xfarc</link>
560                 </term>
561                 <listitem>
562                     <para>Fill a part of an ellipse</para>
563                 </listitem>
564             </varlistentry>
565             <varlistentry>
566                 <term>
567                     <link linkend="xfarcs">xfarcs</link>
568                 </term>
569                 <listitem>
570                     <para>Fill parts of a set of ellipses</para>
571                 </listitem>
572             </varlistentry>
573         </variablelist>
574     </refsection>
575     <refsection>
576         <title>Arrow plotting</title>
577         <variablelist>
578             <varlistentry>
579                 <term>
580                     <link linkend="xarrows">xarrows</link>
581                 </term>
582                 <listitem>
583                     <para>Draw a set of arrows</para>
584                 </listitem>
585             </varlistentry>
586         </variablelist>
587     </refsection>
588     <refsection>
589         <title>Strings</title>
590         <variablelist>
591             <varlistentry>
592                 <term>
593                     <link linkend="xstring">xstring</link>
594                 </term>
595                 <listitem>
596                     <para>Draw strings</para>
597                 </listitem>
598             </varlistentry>
599             <varlistentry>
600                 <term>
601                     <link linkend="xstringl">xstringl</link>
602                 </term>
603                 <listitem>
604                     <para>Compute a box which surrounds strings</para>
605                 </listitem>
606             </varlistentry>
607             <varlistentry>
608                 <term>
609                     <link linkend="xstringb">xstringb</link>
610                 </term>
611                 <listitem>
612                     <para>Draw strings into a box</para>
613                     <para>
614                         <emphasis role="bold">Example:</emphasis>
615                     </para>
616                     <para>
617                         <scilab:image>xstringb();</scilab:image>
618                     </para>
619                 </listitem>
620             </varlistentry>
621             <varlistentry>
622                 <term>
623                     <link linkend="xtitle">xtitle</link>
624                 </term>
625                 <listitem>
626                     <para>Add titles on a graphics window</para>
627                     <para>
628                         <emphasis role="bold">Example:</emphasis>
629                     </para>
630                     <para>
631                         <scilab:image>xtitle();</scilab:image>
632                     </para>
633                 </listitem>
634             </varlistentry>
635             <varlistentry>
636                 <term>
637                     <link linkend="titlepage">titlepage</link>
638                 </term>
639                 <listitem>
640                     <para>Add a title in the middle of a graphics window</para>
641                 </listitem>
642             </varlistentry>
643             <varlistentry>
644                 <term>
645                     <link linkend="xinfo">xinfo</link>
646                 </term>
647                 <listitem>
648                     <para>Draw an info string in the message subwindow</para>
649                 </listitem>
650             </varlistentry>
651         </variablelist>
652     </refsection>
653     <refsection>
654         <title>Frames and axes</title>
655         <variablelist>
656             <varlistentry>
657                 <term>
658                     <link linkend="drawaxis">drawaxis</link>
659                 </term>
660                 <listitem>
661                     <para>Draw an axis</para>
662                 </listitem>
663             </varlistentry>
664             <varlistentry>
665                 <term>
666                     <link linkend="graduate">graduate</link>
667                 </term>
668                 <listitem>
669                     <para>Pretty axis graduations</para>
670                 </listitem>
671             </varlistentry>
672             <varlistentry>
673                 <term>
674                     <link linkend="plotframe">plotframe</link>
675                 </term>
676                 <listitem>
677                     <para>
678                         Plot a frame with scaling and grids
679                         <warning>
680                             This function is obsolete.
681                         </warning>
682                     </para>
683                 </listitem>
684             </varlistentry>
685         </variablelist>
686     </refsection>
687     <refsection>
688         <title>Coordinates transformations</title>
689         <variablelist>
690             <varlistentry>
691                 <term>
692                     <link linkend="isoview">isoview</link>
693                 </term>
694                 <listitem>
695                     <para>
696                         Set scales for isometric plot (do not change the size
697                         of the window)
698                         <warning>
699                             This function is obsolete.
700                         </warning>
701                     </para>
702                 </listitem>
703             </varlistentry>
704             <varlistentry>
705                 <term>
706                     <link linkend="square">square</link>
707                 </term>
708                 <listitem>
709                     <para>Set scales for isometric plot (change the size of the window)</para>
710                 </listitem>
711             </varlistentry>
712             <varlistentry>
713                 <term>
714                     <link linkend="scaling">scaling</link>
715                 </term>
716                 <listitem>
717                     <para>Affine transformation of a set of points</para>
718                 </listitem>
719             </varlistentry>
720             <varlistentry>
721                 <term>
722                     <link linkend="rotate">rotate</link>
723                 </term>
724                 <listitem>
725                     <para>Rotation of a set of points</para>
726                 </listitem>
727             </varlistentry>
728             <varlistentry>
729                 <term>
730                     <link linkend="xsetech">xsetech</link>
731                 </term>
732                 <listitem>
733                     <para>Set the sub-window of a graphics window for plotting</para>
734                 </listitem>
735             </varlistentry>
736             <varlistentry>
737                 <term>
738                     <link linkend="subplot">subplot</link>
739                 </term>
740                 <listitem>
741                     <para>Divide a graphics window into a matrix of sub-windows</para>
742                 </listitem>
743             </varlistentry>
744             <varlistentry>
745                 <term>
746                     <link linkend="xgetech">xgetech</link>
747                 </term>
748                 <listitem>
749                     <para>Get the current graphics scale</para>
750                 </listitem>
751             </varlistentry>
752             <varlistentry>
753                 <term>
754                     <link linkend="xchange">xchange</link>
755                 </term>
756                 <listitem>
757                     <para>Transform real to pixel coordinates</para>
758                 </listitem>
759             </varlistentry>
760         </variablelist>
761     </refsection>
762     <refsection>
763         <title>Colors</title>
764         <variablelist>
765             <varlistentry>
766                 <term>
767                     <link linkend="colormap">colormap</link>
768                 </term>
769                 <listitem>
770                     <para>Using colormaps</para>
771                 </listitem>
772             </varlistentry>
773             <varlistentry>
774                 <term>
775                     <link linkend="getcolor">getcolor</link>
776                 </term>
777                 <listitem>
778                     <para>Dialog to select colors in the current colormap</para>
779                 </listitem>
780             </varlistentry>
781             <varlistentry>
782                 <term>
783                     <link linkend="addcolor">addcolor</link>
784                 </term>
785                 <listitem>
786                     <para>Add new colors to the current colormap</para>
787                 </listitem>
788             </varlistentry>
789             <varlistentry>
790                 <term>
791                     <link linkend="graycolormap">graycolormap</link>
792                 </term>
793                 <listitem>
794                     <para>Linear gray colormap</para>
795                 </listitem>
796             </varlistentry>
797             <varlistentry>
798                 <term>
799                     <link linkend="hotcolormap">hotcolormap</link>
800                 </term>
801                 <listitem>
802                     <para>Red to yellow colormap</para>
803                 </listitem>
804             </varlistentry>
805         </variablelist>
806     </refsection>
807     <refsection>
808         <title>Graphics context</title>
809         <variablelist>
810             <varlistentry>
811                 <term>
812                     <link linkend="xset">xset</link>
813                 </term>
814                 <listitem>
815                     <para>
816                         Set values of the graphics context
817                         <warning>
818                             This function is obsolete.
819                         </warning>
820                     </para>
821                 </listitem>
822             </varlistentry>
823             <varlistentry>
824                 <term>
825                     <link linkend="xget">xget</link>
826                 </term>
827                 <listitem>
828                     <para>
829                         Get current values of the graphics context
830                         <warning>
831                             This function is obsolete.
832                         </warning>
833                     </para>
834                 </listitem>
835             </varlistentry>
836             <varlistentry>
837                 <term>
838                     <link linkend="xlfont">xlfont</link>
839                 </term>
840                 <listitem>
841                     <para>Load a font in the graphics context or query loaded font</para>
842                 </listitem>
843             </varlistentry>
844             <varlistentry>
845                 <term>
846                     <link linkend="getsymbol">getsymbol</link>
847                 </term>
848                 <listitem>
849                     <para>
850                         Dialog to select a symbol and its size
851                         <warning>
852                             This function is obsolete.
853                         </warning>
854                     </para>
855                 </listitem>
856             </varlistentry>
857         </variablelist>
858     </refsection>
859     <refsection>
860         <title>Save and load</title>
861         <variablelist>
862             <varlistentry>
863                 <term>
864                     <link linkend="xsave">xsave</link>
865                 </term>
866                 <listitem>
867                     <para>Save graphics into a file</para>
868                 </listitem>
869             </varlistentry>
870             <varlistentry>
871                 <term>
872                     <link linkend="xload">xload</link>
873                 </term>
874                 <listitem>
875                     <para>Load a saved graphics</para>
876                 </listitem>
877             </varlistentry>
878             <varlistentry>
879                 <term>
880                     <link linkend="xs2bmp">xs2bmp</link>
881                 </term>
882                 <listitem>
883                     <para>Export graphics using the BMP format</para>
884                 </listitem>
885             </varlistentry>
886             <varlistentry>
887                 <term>
888                     <link linkend="xs2emf">xs2emf</link>
889                 </term>
890                 <listitem>
891                     <para>
892                         Export graphics using the EMF format
893                         <warning>
894                             Only under Windows.
895                         </warning>
896                     </para>
897                 </listitem>
898             </varlistentry>
899             <varlistentry>
900                 <term>
901                     <link linkend="xs2eps">xs2eps</link>
902                 </term>
903                 <listitem>
904                     <para>Export graphics using the EPS format</para>
905                 </listitem>
906             </varlistentry>
907             <varlistentry>
908                 <term>
909                     <link linkend="xs2gif">xs2gif</link>
910                 </term>
911                 <listitem>
912                     <para>Export graphics using the GIF format</para>
913                 </listitem>
914             </varlistentry>
915             <varlistentry>
916                 <term>
917                     <link linkend="xs2jpg">xs2jpg</link>
918                 </term>
919                 <listitem>
920                     <para>Export graphics using the JPG format</para>
921                 </listitem>
922             </varlistentry>
923             <varlistentry>
924                 <term>
925                     <link linkend="xs2pdf">xs2pdf</link>
926                 </term>
927                 <listitem>
928                     <para>Export graphics using the PDF format</para>
929                 </listitem>
930             </varlistentry>
931             <varlistentry>
932                 <term>
933                     <link linkend="xs2png">xs2png</link>
934                 </term>
935                 <listitem>
936                     <para>Export graphics using the PNG format</para>
937                 </listitem>
938             </varlistentry>
939             <varlistentry>
940                 <term>
941                     <link linkend="xs2ppm">xs2ppm</link>
942                 </term>
943                 <listitem>
944                     <para>Export graphics using the PPM format</para>
945                 </listitem>
946             </varlistentry>
947             <varlistentry>
948                 <term>
949                     <link linkend="xs2ps">xs2ps</link>
950                 </term>
951                 <listitem>
952                     <para>Export graphics using the PS format</para>
953                 </listitem>
954             </varlistentry>
955             <varlistentry>
956                 <term>
957                     <link linkend="xs2svg">xs2svg</link>
958                 </term>
959                 <listitem>
960                     <para>Export graphics using the SVG format</para>
961                 </listitem>
962             </varlistentry>
963         </variablelist>
964     </refsection>
965     <refsection>
966         <title>Graphics primitives</title>
967         <variablelist>
968             <varlistentry>
969                 <term>
970                     <link linkend="clf">clf</link>
971                 </term>
972                 <listitem>
973                     <para>
974                         Clear or reset the current graphic figure (window) to default values
975                     </para>
976                 </listitem>
977             </varlistentry>
978             <varlistentry>
979                 <term>
980                     <link linkend="xclear">xclear</link>
981                 </term>
982                 <listitem>
983                     <para>
984                         Clear a graphics window
985                         <warning>
986                             Function <function>xclear</function> is obsolete.
987                         </warning>
988                     </para>
989                 </listitem>
990             </varlistentry>
991             <varlistentry>
992                 <term>
993                     <link linkend="driver">driver</link>
994                 </term>
995                 <listitem>
996                     <para>Select a graphics driver</para>
997                 </listitem>
998             </varlistentry>
999             <varlistentry>
1000                 <term>
1001                     <link linkend="xinit">xinit</link>
1002                 </term>
1003                 <listitem>
1004                     <para>Initialisation of a graphics driver</para>
1005                 </listitem>
1006             </varlistentry>
1007             <varlistentry>
1008                 <term>
1009                     <link linkend="xend">xend</link>
1010                 </term>
1011                 <listitem>
1012                     <para>Close a graphics session</para>
1013                 </listitem>
1014             </varlistentry>
1015             <varlistentry>
1016                 <term>
1017                     <link linkend="replot">replot</link>
1018                 </term>
1019                 <listitem>
1020                     <para>Redraw the current graphics window with new boundaries</para>
1021                 </listitem>
1022             </varlistentry>
1023             <varlistentry>
1024                 <term>
1025                     <link linkend="xpause">xpause</link>
1026                 </term>
1027                 <listitem>
1028                     <para>Suspend Scilab</para>
1029                 </listitem>
1030             </varlistentry>
1031             <varlistentry>
1032                 <term>
1033                     <link linkend="show_window">show_window</link>
1034                 </term>
1035                 <listitem>
1036                     <para>Raise the current graphics window</para>
1037                 </listitem>
1038             </varlistentry>
1039             <varlistentry>
1040                 <term>
1041                     <link linkend="xdel">xdel</link>
1042                 </term>
1043                 <listitem>
1044                     <para>Delete a graphics window</para>
1045                 </listitem>
1046             </varlistentry>
1047             <varlistentry>
1048                 <term>
1049                     <link linkend="winsid">winsid</link>
1050                 </term>
1051                 <listitem>
1052                     <para>Return the list of graphics windows</para>
1053                 </listitem>
1054             </varlistentry>
1055             <varlistentry>
1056                 <term>
1057                     <link linkend="xname">xname</link>
1058                 </term>
1059                 <listitem>
1060                     <para>Change the name of the current graphics window</para>
1061                 </listitem>
1062             </varlistentry>
1063         </variablelist>
1064     </refsection>
1065     <refsection>
1066         <title>Mouse position</title>
1067         <variablelist>
1068             <varlistentry>
1069                 <term>
1070                     <link linkend="xclick">xclick</link>
1071                 </term>
1072                 <listitem>
1073                     <para>
1074                         Wait for a mouse click or an event in a graphic window
1075                     </para>
1076                 </listitem>
1077             </varlistentry>
1078             <varlistentry>
1079                 <term>
1080                     <link linkend="locate">locate</link>
1081                 </term>
1082                 <listitem>
1083                     <para>Mouse selection of a set of points</para>
1084                 </listitem>
1085             </varlistentry>
1086             <varlistentry>
1087                 <term>
1088                     <link linkend="xgetmouse">xgetmouse</link>
1089                 </term>
1090                 <listitem>
1091                     <para>Get the mouse events and current position</para>
1092                 </listitem>
1093             </varlistentry>
1094         </variablelist>
1095     </refsection>
1096     <refsection>
1097         <title>Interactive editor</title>
1098         <variablelist>
1099             <varlistentry>
1100                 <term>
1101                     <link linkend="edit_curv">edit_curv</link>
1102                 </term>
1103                 <listitem>
1104                     <para>Interactive graphics curve editor</para>
1105                 </listitem>
1106             </varlistentry>
1107         </variablelist>
1108     </refsection>
1109     <refsection>
1110         <title>Graphics functions for automatic control</title>
1111         <variablelist>
1112             <varlistentry>
1113                 <term>
1114                     <link linkend="bode">bode</link>
1115                 </term>
1116                 <listitem>
1117                     <para>Bode plot</para>
1118                     <para>
1119                         <emphasis role="bold">Example:</emphasis>
1120                     </para>
1121                     <para>
1122                         <scilab:image>s=poly(0,'s')
1123                             h=syslin('c',(s^2+2*0.9*10*s+100)/(s^2+2*0.3*10.1*s+102.01))
1124                             clf();bode(h,0.01,100);
1125                         </scilab:image>
1126                     </para>
1127                 </listitem>
1128             </varlistentry>
1129             <varlistentry>
1130                 <term>
1131                     <link linkend="gainplot">gainplot</link>
1132                 </term>
1133                 <listitem>
1134                     <para>Magnitude plot</para>
1135                     <para>
1136                         <emphasis role="bold">Example:</emphasis>
1137                     </para>
1138                     <para>
1139                         <scilab:image>s=poly(0,'s')
1140                             h1=syslin('c',(s^2+2*0.9*10*s+100)/(s^2+2*0.3*10.1*s+102.01))
1141                             h2=syslin('c',(s^2+2*0.1*15.1*s+228.01)/(s^2+2*0.9*15*s+225))
1142                             clf();gainplot([h1;h2],0.01,100,['h1';'h2'])
1143                             title('Gainplot');
1144                         </scilab:image>
1145                     </para>
1146                 </listitem>
1147             </varlistentry>
1148             <varlistentry>
1149                 <term>
1150                     <link linkend="nyquist">nyquist</link>
1151                 </term>
1152                 <listitem>
1153                     <para>Nyquist plot</para>
1154                     <para>
1155                         <emphasis role="bold">Example:</emphasis>
1156                     </para>
1157                     <para>
1158                         <scilab:image>s=poly(0,'s')
1159                             h=syslin('c',(s^2+2*0.9*10*s+100)/(s^2+2*0.3*10.1*s+102.01));
1160                             h1=h*syslin('c',(s^2+2*0.1*15.1*s+228.01)/(s^2+2*0.9*15*s+225))
1161                             nyquist(h1)
1162                             ax=gca();
1163                             h_h=ax.children($).children(2);
1164                             tip=datatipCreate(h_h,[1.331,0.684]);
1165                             datatipSetOrientation(tip,"upper left");
1166                         </scilab:image>
1167                     </para>
1168                 </listitem>
1169             </varlistentry>
1170             <varlistentry>
1171                 <term>
1172                     <link linkend="m_circle">m_circle</link>
1173                 </term>
1174                 <listitem>
1175                     <para>
1176                         Plot the complex plane iso-gain contours of y/(1+y)
1177                         <warning>
1178                             This function is obsolete.
1179                         </warning>
1180                     </para>
1181                     <para>
1182                         <emphasis role="bold">Example:</emphasis>
1183                     </para>
1184                     <para>
1185                         <scilab:image>m_circle();</scilab:image>
1186                     </para>
1187                 </listitem>
1188             </varlistentry>
1189             <varlistentry>
1190                 <term>
1191                     <link linkend="hallchart">hallchart</link>
1192                 </term>
1193                 <listitem>
1194                     <para>
1195                         Hall chart
1196                     </para>
1197                     <para>
1198                         <emphasis role="bold">Example:</emphasis>
1199                     </para>
1200                     <para>
1201                         <scilab:image localized="true">hallchart();</scilab:image>
1202                     </para>
1203                 </listitem>
1204             </varlistentry>
1205             <varlistentry>
1206                 <term>
1207                     <link linkend="chart">chart</link>
1208                 </term>
1209                 <listitem>
1210                     <para>Nichols chart</para>
1211                     <para>
1212                         <emphasis role="bold">Example:</emphasis>
1213                     </para>
1214                     <para>
1215                         <scilab:image localized="true">chart();</scilab:image>
1216                     </para>
1217                 </listitem>
1218             </varlistentry>
1219             <varlistentry>
1220                 <term>
1221                     <link linkend="black">black</link>
1222                 </term>
1223                 <listitem>
1224                     <para>Black's diagram</para>
1225                     <para>
1226                         <emphasis role="bold">Example:</emphasis>
1227                     </para>
1228                     <para>
1229                         <scilab:image localized="true">s=poly(0,'s');
1230                             sl=syslin('c',5*(1+s)/(.1*s^4+s^3+15*s^2+3*s+1))
1231                             clf();black(sl,0.01,10);
1232                         </scilab:image>
1233                     </para>
1234                 </listitem>
1235             </varlistentry>
1236             <varlistentry>
1237                 <term>
1238                     <link linkend="evans">evans</link>
1239                 </term>
1240                 <listitem>
1241                     <para>Evans root locus</para>
1242                     <para>
1243                         <emphasis role="bold">Example:</emphasis>
1244                     </para>
1245                     <para>
1246                         <scilab:image localized="true">evans();</scilab:image>
1247                     </para>
1248                 </listitem>
1249             </varlistentry>
1250             <varlistentry>
1251                 <term>
1252                     <link linkend="sgrid">sgrid</link>
1253                 </term>
1254                 <listitem>
1255                     <para>s-plane grid lines</para>
1256                     <para>
1257                         <emphasis role="bold">Example:</emphasis>
1258                     </para>
1259                     <para>
1260                         <scilab:image localized="true">sgrid();</scilab:image>
1261                     </para>
1262                 </listitem>
1263             </varlistentry>
1264             <varlistentry>
1265                 <term>
1266                     <link linkend="plzr">plzr</link>
1267                 </term>
1268                 <listitem>
1269                     <para>pole-zero plot</para>
1270                     <para>
1271                         <emphasis role="bold">Example:</emphasis>
1272                     </para>
1273                     <para>
1274                         <scilab:image localized="true">s=poly(0,'s');
1275                             n=[1+s   2+3*s+4*s^2        5; 0        1-s             s];
1276                             d=[1+3*s   5-s^3           s+1;1+s     1+s+s^2      3*s-1];
1277                             h=syslin('c',n./d);
1278                             plzr(h);
1279                         </scilab:image>
1280                     </para>
1281                 </listitem>
1282             </varlistentry>
1283             <varlistentry>
1284                 <term>
1285                     <link linkend="zgrid">zgrid</link>
1286                 </term>
1287                 <listitem>
1288                     <para>zgrid plot</para>
1289                     <para>
1290                         <emphasis role="bold">Example:</emphasis>
1291                     </para>
1292                     <para>
1293                         <scilab:image localized="true">zgrid();</scilab:image>
1294                     </para>
1295                 </listitem>
1296             </varlistentry>
1297         </variablelist>
1298     </refsection>
1299 </refentry>