* Bug #8784 fixed - Autoscale for cscope graph
[scilab.git] / scilab / modules / xcos / help / en_US / palettes / Sinks_pal / AA_Sinks_pal.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scicos
4  *
5  * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
6  * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  * See the file ./license.txt
23  -->
24 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="Sinks_pal">
25     <refnamediv>
26         <refname>Sinks_pal</refname>
27         <refpurpose>Sinks palette</refpurpose>
28     </refnamediv>
29     <refsection>
30         <title>Block Screenshot</title>
31         <para>
32             <inlinemediaobject>
33                 <imageobject>
34                     <imagedata linkend="AFFICH_m" fileref="../../../../../../modules/xcos/images/palettes/AFFICH_m.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
35                 </imageobject>
36             </inlinemediaobject>
37             <inlinemediaobject>
38                 <imageobject>
39                     <imagedata linkend="CANIMXY" fileref="../../../../../../modules/xcos/images/palettes/CANIMXY.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
40                 </imageobject>
41             </inlinemediaobject>
42             <inlinemediaobject>
43                 <imageobject>
44                     <imagedata linkend="CANIMXY3D" fileref="../../../../../../modules/xcos/images/palettes/CANIMXY3D.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
45                 </imageobject>
46             </inlinemediaobject>
47             <inlinemediaobject>
48                 <imageobject>
49                     <imagedata linkend="CFSCOPE" fileref="../../../../../../modules/xcos/images/palettes/CFSCOPE.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
50                 </imageobject>
51             </inlinemediaobject>
52             <inlinemediaobject>
53                 <imageobject>
54                     <imagedata linkend="CLKOUTV_f" fileref="../../../../../../modules/xcos/images/palettes/CLKOUTV_f.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
55                 </imageobject>
56             </inlinemediaobject>
57             <inlinemediaobject>
58                 <imageobject>
59                     <imagedata linkend="CMAT3D" fileref="../../../../../../modules/xcos/images/palettes/CMAT3D.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
60                 </imageobject>
61             </inlinemediaobject>
62             <inlinemediaobject>
63                 <imageobject>
64                     <imagedata linkend="CMATVIEW" fileref="../../../../../../modules/xcos/images/palettes/CMATVIEW.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
65                 </imageobject>
66             </inlinemediaobject>
67             <inlinemediaobject>
68                 <imageobject>
69                     <imagedata linkend="CMSCOPE" fileref="../../../../../../modules/xcos/images/palettes/CMSCOPE.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
70                 </imageobject>
71             </inlinemediaobject>
72             <inlinemediaobject>
73                 <imageobject>
74                     <imagedata linkend="CSCOPE" fileref="../../../../../../modules/xcos/images/palettes/CSCOPE.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
75                 </imageobject>
76             </inlinemediaobject>
77              <inlinemediaobject>
78                 <imageobject>
79                     <imagedata linkend="SCALE_CSCOPE" fileref="../../../../../../modules/xcos/images/palettes/SCALE_CSCOPE.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
80                 </imageobject>
81             </inlinemediaobject>
82             <inlinemediaobject>
83                 <imageobject>
84                     <imagedata linkend="CSCOPXY" fileref="../../../../../../modules/xcos/images/palettes/CSCOPXY.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
85                 </imageobject>
86             </inlinemediaobject>
87             <inlinemediaobject>
88                 <imageobject>
89                     <imagedata linkend="CSCOPXY3D" fileref="../../../../../../modules/xcos/images/palettes/CSCOPXY3D.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
90                 </imageobject>
91             </inlinemediaobject>
92             <inlinemediaobject>
93                 <imageobject>
94                     <imagedata linkend="ENDBLK" fileref="../../../../../../modules/xcos/images/palettes/ENDBLK.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
95                 </imageobject>
96             </inlinemediaobject>
97             <inlinemediaobject>
98                 <imageobject>
99                     <imagedata linkend="END_c" fileref="../../../../../../modules/xcos/images/palettes/END_c.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
100                 </imageobject>
101             </inlinemediaobject>
102             <inlinemediaobject>
103                 <imageobject>
104                     <imagedata linkend="HALT_f" fileref="../../../../../../modules/xcos/images/palettes/HALT_f.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
105                 </imageobject>
106             </inlinemediaobject>
107             <inlinemediaobject>
108                 <imageobject>
109                     <imagedata linkend="OUTIMPL_f" fileref="../../../../../../modules/xcos/images/palettes/OUTIMPL_f.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
110                 </imageobject>
111             </inlinemediaobject>
112             <inlinemediaobject>
113                 <imageobject>
114                     <imagedata linkend="OUT_f" fileref="../../../../../../modules/xcos/images/palettes/OUT_f.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
115                 </imageobject>
116             </inlinemediaobject>
117             <inlinemediaobject>
118                 <imageobject>
119                     <imagedata linkend="TOWS_c" fileref="../../../../../../modules/xcos/images/palettes/TOWS_c.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
120                 </imageobject>
121             </inlinemediaobject>
122             <inlinemediaobject>
123                 <imageobject>
124                     <imagedata linkend="TRASH_f" fileref="../../../../../../modules/xcos/images/palettes/TRASH_f.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
125                 </imageobject>
126             </inlinemediaobject>
127             <inlinemediaobject>
128                 <imageobject>
129                     <imagedata linkend="WRITEAU_f" fileref="../../../../../../modules/xcos/images/palettes/WRITEAU_f.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
130                 </imageobject>
131             </inlinemediaobject>
132             <inlinemediaobject>
133                 <imageobject>
134                     <imagedata linkend="WRITEC_f" fileref="../../../../../../modules/xcos/images/palettes/WRITEC_f.png" width="100" depth="100" scalefit="0" align="center" valign="middle"/>
135                 </imageobject>
136             </inlinemediaobject>
137         </para>
138     </refsection>
139     <refsection id="Module_Sinks_pal">
140         <title>Module</title>
141         <itemizedlist>
142             <listitem>
143                 <para>
144                     <link linkend="xcos">xcos</link>
145                 </para>
146             </listitem>
147         </itemizedlist>
148     </refsection>
149     <refsection id="Description_Sinks_pal">
150         <title>Description</title>
151         <para>In Sinks palette, you can find a variety of blocks used to display
152             (Scope) and write data during simulation and also some output ports used
153             in superblocks.
154         </para>
155         <para>The blocks of that palette does not have regular output
156             ports.
157         </para>
158     </refsection>
159     <refsection id="Blocks_Sinks_pal">
160         <title>Blocks</title>
161         <itemizedlist>
162             <listitem>
163                 <para>
164                     <link linkend="AFFICH_m">AFFICH_m - Display</link>
165                 </para>
166             </listitem>
167             <listitem>
168                 <para>
169                     <link linkend="CANIMXY">CANIMXY - y=f(x) animated viewer</link>
170                 </para>
171             </listitem>
172             <listitem>
173                 <para>
174                     <link linkend="CANIMXY3D">CANIMXY3D - z=f(x,y) animated
175                         viewer
176                     </link>
177                 </para>
178             </listitem>
179             <listitem>
180                 <para>
181                     <link linkend="CFSCOPE">CFSCOPE - Floating point scope</link>
182                 </para>
183             </listitem>
184             <listitem>
185                 <para>
186                     <link linkend="CLKOUTV_f">CLKOUTV_f - Output activation port</link>
187                 </para>
188             </listitem>
189             <listitem>
190                 <para>
191                     <link linkend="CMAT3D">CMAT3D - Matrix z values 3D viewer</link>
192                 </para>
193             </listitem>
194             <listitem>
195                 <para>
196                     <link linkend="CMATVIEW">CMATVIEW - Matrix Colormapped viewer</link>
197                 </para>
198             </listitem>
199             <listitem>
200                 <para>
201                     <link linkend="CMSCOPE">CMSCOPE - Multi display scope</link>
202                 </para>
203             </listitem>
204             <listitem>
205                 <para>
206                     <link linkend="CSCOPE">CSCOPE - Single Display Scope</link>
207                 </para>
208             </listitem>
209             <listitem>
210                 <para>
211                     <link linkend="SCALE_CSCOPE">CSCOPE - Single Display Scope with Autoscale Graph Feature</link>
212                 </para>
213             </listitem>
214             <listitem>
215                 <para>
216                     <link linkend="CSCOPXY">CSCOPXY - y=f(x) permanent viewer</link>
217                 </para>
218             </listitem>
219             <listitem>
220                 <para>
221                     <link linkend="CSCOPXY3D">CSCOPXY3D - z=f(x,y) permanent
222                         viewer
223                     </link>
224                 </para>
225             </listitem>
226             <listitem>
227                 <para>
228                     <link linkend="ENDBLK">ENDBLK - END block
229                         viewer
230                     </link>
231                 </para>
232             </listitem>
233             <listitem>
234                 <para>
235                     <link linkend="END_c">END_c - END_c block
236                         viewer
237                     </link>
238                 </para>
239             </listitem>
240             <listitem>
241                 <para>
242                     <link linkend="HALT_f">HALT_f - Halt block
243                         viewer
244                     </link>
245                 </para>
246             </listitem>
247             <listitem>
248                 <para>
249                     <link linkend="OUTIMPL_f">OUTIMPL_f - Output implicit port
250                         viewer
251                     </link>
252                 </para>
253             </listitem>
254             <listitem>
255                 <para>
256                     <link linkend="OUT_f">OUT_f - Output port
257                         viewer
258                     </link>
259                 </para>
260             </listitem>
261             <listitem>
262                 <para>
263                     <link linkend="TOWS_c">TOWS_c - Data to Scilab workspace</link>
264                 </para>
265             </listitem>
266             <listitem>
267                 <para>
268                     <link linkend="TRASH_f">TRASH_f — Trash block</link>
269                 </para>
270             </listitem>
271             <listitem>
272                 <para>
273                     <link linkend="WRITEAU_f">WRITEAU_f — Write AU sound file</link>
274                 </para>
275             </listitem>
276             <listitem>
277                 <para>
278                     <link linkend="WRITEC_f">Write binary data</link>
279                 </para>
280             </listitem>
281         </itemizedlist>
282     </refsection>
283 </refentry>