xcos help (US and Fr)
[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., 675 Mass Ave, Cambridge, MA 02139, USA.
21  * 
22  * See the file ./license.txt
23  -->
24 <refentry version="5.0-subset Scilab" xml:id="Sinks_pal"
25           xmlns="http://docbook.org/ns/docbook"
26           xmlns:xlink="http://www.w3.org/1999/xlink"
27           xmlns:svg="http://www.w3.org/2000/svg"
28           xmlns:ns4="http://www.w3.org/1999/xhtml"
29           xmlns:mml="http://www.w3.org/1998/Math/MathML"
30           xmlns:db="http://docbook.org/ns/docbook">
31   <refnamediv>
32     <refname>Sinks_pal</refname>
33
34     <refpurpose>Sinks palette</refpurpose>
35   </refnamediv>
36
37   <refsection>
38     <title>Block Screenshot</title>
39
40     <para><inlinemediaobject>
41         <imageobject>
42           <imagedata align="center"
43                      fileref="../../../../images/palettes/Sinks_pal.jpg"
44                      valign="middle"></imagedata>
45         </imageobject>
46       </inlinemediaobject></para>
47   </refsection>
48
49   <refsection id="Module_Sinks_pal">
50     <title>Module</title>
51
52     <itemizedlist>
53       <listitem>
54         <para>
55           <link linkend="xcos">xcos</link>
56         </para>
57       </listitem>
58     </itemizedlist>
59   </refsection>
60
61   <refsection id="Description_Sinks_pal">
62     <title>Description</title>
63
64     <para>
65       <para>In Sinks palette, you can find a variety of blocks used to display
66       (Scope) and write data during simulation and also some output ports used
67       in superblocks.</para>
68
69       <para>The blocks of that palette doesn't have regular output
70       ports.</para>
71     </para>
72   </refsection>
73
74   <refsection id="Blocks_Sinks_pal">
75     <title>Blocks</title>
76
77     <itemizedlist>
78       <listitem>
79         <para>
80           <link linkend="AFFICH_m">AFFICH_m - Display</link>
81         </para>
82       </listitem>
83
84       <listitem>
85         <para>
86           <link linkend="CANIMXY">CANIMXY - y=f(x) animated viewer</link>
87         </para>
88       </listitem>
89
90       <listitem>
91         <para>
92           <link linkend="CANIMXY3D">CANIMXY3D - z=f(x,y) animated
93           viewer</link>
94         </para>
95       </listitem>
96
97       <listitem>
98         <para>
99           <link linkend="CFSCOPE">CFSCOPE - Floating point scope</link>
100         </para>
101       </listitem>
102           
103           <listitem>
104         <para>
105           <link linkend="CLKOUTV_f">CLKOUTV_f - Output activation port</link>
106         </para>
107       </listitem>
108
109       <listitem>
110         <para>
111           <link linkend="CMAT3D">CMAT3D - Matrix z values 3D viewer</link>
112         </para>
113       </listitem>
114
115       <listitem>
116         <para>
117           <link linkend="CMATVIEW">CMATVIEW - Matrix Colormapped viewer</link>
118         </para>
119       </listitem>
120
121       <listitem>
122         <para>
123           <link linkend="CMSCOPE">CMSCOPE - Multi display scope</link>
124         </para>
125       </listitem>
126
127       <listitem>
128         <para>
129           <link linkend="CSCOPE">CSCOPE - Single Display Scope</link>
130         </para>
131       </listitem>
132
133       <listitem>
134         <para>
135           <link linkend="CSCOPXY">CSCOPXY - y=f(x) permanent viewer</link>
136         </para>
137       </listitem>
138
139       <listitem>
140         <para>
141           <link linkend="CSCOPXY3D">CSCOPXY3D - z=f(x,y) permanent
142           viewer</link>
143         </para>
144       </listitem>
145           
146           <listitem>
147         <para>
148           <link linkend="ENDBLK">ENDBLK - END block
149           viewer</link>
150         </para>
151       </listitem>
152           
153           <listitem>
154         <para>
155           <link linkend="END_c">END_c - END_c block
156           viewer</link>
157         </para>
158       </listitem>
159           
160           <listitem>
161         <para>
162           <link linkend="HALT_f">HALT_f - Halt block
163           viewer</link>
164         </para>
165       </listitem>
166           
167           <listitem>
168         <para>
169           <link linkend="OUTIMPL_f">OUTIMPL_f - Output implicit port
170           viewer</link>
171         </para>
172       </listitem>
173           
174           <listitem>
175         <para>
176           <link linkend="OUT_f">OUT_f - Output port
177           viewer</link>
178         </para>
179       </listitem>
180
181       <listitem>
182         <para>
183           <link linkend="TOWS_c">TOWS_c - Data to Scilab worspace</link>
184         </para>
185       </listitem>
186
187       <listitem>
188         <para>
189           <link linkend="TRASH_f">TRASH_f — Trash block</link>
190         </para>
191       </listitem>
192
193       <listitem>
194         <para>
195           <link linkend="WFILE_f">WFILE_f — Write to file</link>
196         </para>
197       </listitem>
198
199       <listitem>
200         <para>
201           <link linkend="MUX">
202             <refname linkend="WRITEAU_f">WRITEAU_f — Write AU sound
203             file</refname>
204           </link>
205         </para>
206       </listitem>
207
208       <listitem>
209         <para>
210           <link linkend="NRMSOM_f">
211             <refname linkend="WRITEC_f">WRITEC_f</refname>
212
213             <refpurpose linkend="WRITEC_f">Write binary data</refpurpose>
214           </link>
215         </para>
216       </listitem>
217     </itemizedlist>
218   </refsection>
219 </refentry>